GET List User
This API will fetch list of the users for the specified company.
Request Attributes
API Content Type: JSON
Head
ATTRIBUTE | DESCRIPTION |
---|---|
x-access-token
string
mandatory
|
Token generated from the authentication api.
Example:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.TU5NzgyMDA1N30.9eO_xh
eyJEYXRhIjp7InVzZXJpZCI6IjY3NCIsImVtYWlsIjoiYWFhYWFhYWFhYWjuunGJQ
YmwuY29tIiwia2V5IjoidGVzdGluZ0tleSJ9LCJpYXQiOjE1OTc3NDA4NTpj6gc8dM
csIFhY7n1mV4cUBxa2P3ICI6M2VyWq19OzuHAefeTEj
|
body
ATTRIBUTE | DESCRIPTION |
---|---|
company_id
string
mandatory
|
Example:
It is the Id of the company for
which user's list will be fetched.
ZmE1MjAI3Nzc4MmUyYjYtZTtyMDE4NIY0ZS00MTY3LWNjTM1Ng==
|
user_id
string
mandatory
|
Example:
It is Id of the user, it can be fetched
from developer console in company module in KONSIGN.
ZmE1MjAI3Nzc4MmUyYjYtZTtyMDE4NIY0ZS00MTY3LWNjTM1Ng==
|
page_no
integer
mandatory
|
Example:
No. of Page
0
|
pagesize
integer
mandatory
|
Example:
Size of the page
10
|
Response Attributes
API Content Type: JSON
body
ATTRIBUTE | DESCRIPTION | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
statuscode
string(3)
|
This is the status code corresponding to a particular message
and is returned to the user.
The different status codes corresponding to this API are
mentioned below
Example: 200
|
||||||||||||||||||||||||||||||||
status
boolean
|
This parameter indicates the status of API call.
Possible Values: true or false
|
||||||||||||||||||||||||||||||||
message
string
|
This parameter indicates the message of API call.
Example: User details get successfully.
|
||||||||||||||||||||||||||||||||
|
Response Codes and Messages
statuscode | status | Description |
---|---|---|
200
|
true
|
Success |
422
|
false
|
Invalid parameter |
500
|
false
|
System error |