Skip to main content

Get All Users

GET /users

Description

This endpoint allows you to retrieve details about all users in the Sabi Wallet system.

Required Headers

TypeDescription
apiKeystring(Required). Wallet API key for authentication. Include in the request header.
Authorizationstring(Required). Authentication token. Include in the request header using the "Bearer" scheme. Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJfaWQiOiI2NGQ2Nm...

Query Parameters:

NameTypeDescription
countrystringOptional. The country code.
pageintegerOptional. The page number for pagination.
sizeintegerOptional. The number of items to return per page.
ParameterTypeDescription
errorsArrayAn array containing objects, each describing a specific error condition.
messageStringA concise error message indicating the nature of the issue.
descriptiveMessageStringA more detailed and descriptive message providing additional context or information about the error.

Responses

Success Response (200)

Returned when the request is successful.

  • Media type: application/json

  • Example Value:

{
"status": true,
"statusCode": 0,
"message": "string",
"data": {},
"errors": [
{
"message": "string",
"descriptiveMessage": "string"
}
]
}

Error Response (400)

Returned in case of a validation error.

  • Media type: application/json

  • Example Value:

{
"status": false,
"statusCode": 400,
"message": "Validation Error",
"data": {},
"errors": [
{
"message": "string",
"descriptiveMessage": "string"
}
]
}

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST


curl --request GET \ 
--url /users \
--header 'accept: application/json' \
--header 'content-type: application/json'

RESPONSE


Click Try It! to start a request and see the response here!