Lipisha REST APIs


Get Users


API Description

This API call returns all users matching the specified query parameters.

API Endpoint

The API service endpoint for making the Get Users API call is:

http://developer.lipisha.com/index.php/v2/api/get_users

API Request

The API request is made via HTTP POST and must be url encoded. Some of the parameters are required while others are optional. The parameters are:

Parameter Description Example
api_key Unique string specifying merchant's Lipisha API key.

This should match the api key that you have generated for your Lipisha account
3aa67677e8bf1d4c8fe886a38c03a860
api_signature Unique string specifying merchant's Lipisha API signature.

This should match the api signature that you have generated for your Lipisha account
SYetmwsNnb5bwaZRyeQ..........KhZNNkCoEx+5x=
api_version String specifying the version of the API in use 1.3.0
api_type String specifying the type of handshake or IPN call Callback
user_name The user name of the user johndoe
full_name The full name of the user John Doe
role The role of the user Accountant
mobile_number The mobile number of the user 254712345678
email The email address of the user john@doe.com

API Response

The API reponse will be returned as JSON. Each response will contain a status and content section. The parameters are:

Parameter Description Example
Status
status String specifying whether API Call executed successfully or failed SUCCESS
status_code Integers specifying status code of the API Call result 0000
status_description String containing description of the status User created successfully
Content
Array Of User
user_name The user name of the user johndoe
full_name The full name of the user John Doe
role The role assigned to the user Accountant
mobile_number The mobile number of the user 254712345678
email The email address of the user john@doe.com

JSON Reponse
{
  "status": {
    "status_code": "0000",
    "status_description": "Users found",
    "status": "SUCCESS"
  },
  "content": 
  	[
		{
			"user_name": "johndoe",
			"full_name": "John Doe",
			"role": "Accountant",
			"mobile_number": "johndoe",
			"email": "john@doe.com"
		},
		{
			"user_name": "janedoe",
			"full_name": "Jane Doe",
			"role": "Manager",
			"mobile_number": "janedoe",
			"email": "jane@doe.com"
		}
	]
}

Fork me on GitHub