Skip to main content

Get User List

GET : http://<base_url>/digipay/v3/user/user_detail

This API used to get user detail list into the system.

BODY PARAMS:-

ParameterTypeDescriptionValue
user_idStringunqiue id assigned to role detail64b835cb80b542d199c47caf5ccd4351
user_typeIntInterger type of user2
created_byStringPrimary ID of created person51f0785706b748bd8c0062d8d37a8fcd
updated_dateStringa unix date of time1234
status_idInt2
kyc_statusInt2
kyc_process_statusInt2
is_activeBooleana keyword which can be either name of language or a language code to get desired language as outputtrue/false
skipIntSkip the first n document from the query result2
limitIntLimits the number of records or documents that you want2
start_datelongunix timestamp value in second2
end_datelongunix timestamp value in second2
sortingStringSorting of the Data in the form of a string123
search_keywordStringa keyword which can be either name of language or a language code to get desired language as output123

HEADERS:-

ParameterTypeDescriptionValue
AuthorizationStringIt is a combination of type and token to authenticate user for the given tokenToken duik7309njdlkhdauhknksadhjkas986876sd873j
CompanyIDStringCompany_id is a unique primary id, that is represent company detail76bc712200ca444fa334f9e55e5fd7a8

Request Body:-

Request Example
curl --request GET \
--url 'http://192.168.1.102:8014/digipay/v3/user/user_detail?user_id=51f0785706b748bd8c0062d8d37a8fcd&created_by=51f0785706b748bd8c0062d8d37a8fcd&user_type=2&status_id=2&search_keyword=123&kyc_status=2&kyc_process_status=2&is_active=false&skip=1&limit=1&start_date=1&end_date=1' \
--header 'Authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI2NWY0ZDI1MDliZmU0NTBmYTg4MTVhNTU5Njk3YmM0NyIsInJvbGVzIjpbIlJPTEVfQURNSU4iXSwiZXhwIjoxNjkzNTIxOTU1fQ.9oWwUzlFzmYB1ZOhaVamxKJH6DsMO8tFue2kbg2YyoI' \
--header 'CompanyID: 76bc712200ca444fa334f9e55e5fd7a8' \
--header 'accept: application/json'

Response:-

Response 200(OK)

{
"success": 1,
"error": [],
"data": {
"user_detail": {
"id": "3953ad6bd8cf48f5b1312fd21eb3657b",
"first_name": ""DSAd",
"last_name": ""cdZADc",
"email": "sd@fdsf.com",
"dial_code": ""+509"",
"phone_number"": ""14141415"",
"user_type"": 35,
"role_id": "2290c773342642b2a8938cce592ac991",
"account_number": "1646643688464",
"verification": {
"is_email": false,
"is_phone": true
},
"status_id"": 1,
"birth_date"": 1078203600,
"image"": null,
"user_code"": "AGT_GKEOZTUR"",
"address"": "Delmas 19, Rue Mackendal #8, Port-au-Prince, Haiti",
"postal_code"": "152646",
"country_id"": null,
"state_id"": "a45ed21f95614aefb841359510bd754c",
"city_id"": "a45ed21f95614aefb841359510bd754c"",
"kyc_status"": ""1"",
"kyc_process_status": 1,
"location_point": {
"type"": "Point",
"coordinates"": [
-72.333333,
18.533333333333335
]
},
"rating": null,
"parent_user_id": "6254ea7b5e41c36e026221f921f9",
"display_name": "Test business name"
}
}
}
Response 400(BAD REQUEST)
{
"success": 0,
"error"": [1],
"data": {
"message": "BAD_REQUEST",
}
}

RESPONSES :-

Status CodeDescription
200OK
400Bad Request
404Not Found
500Internal Server Error