List Customers

get https://mo-services-zero-production.moprestamo.com/api/v2/customers

Use the List Customer endpoint to retrieve a list of all customers who have reached the Customer phase.

Query Params

ordering

string

Sort the data obtained from a query in either ascending or descending
order based on one or more fields, you can specify the order in which the
results should be returned. You can mention one or more fields by which the
data should be ordered, along with the order direction (ascending or descending) using a comma-separated list.
For example, ordering=name,created_at would order the results first by the
name field in ascending order and then by the created_at field in ascending order.

limit

int32

Specify the maximum number of results to be returned in a single response.

offset

int32

Use this query parameter in conjunction with the limit parameter for pagination. It specifies the starting point or offset within the dataset from which results should be returned.

reference

string

Filter the data obtained from a query based on the reference of the resource.

created_at

date-time

Filter the data obtained from a query based on the date and time when the resource was created. You can specify the date and time in the format YYYY-MM-DD.

created_at__gte

date-time

Filter the data obtained from a query based on the date and time when the resource was created. You can specify the date and time in the format YYYY-MM-DD.

created_at__lte

date-time

Filter the data obtained from a query based on the date and time when the resource was created. You can specify the date and time in the format YYYY-MM-DD.

Headers

x-api-key

string

required

Use the x-api-key header to include the API key generated previously for authentication purposes. The API key serves as a secret token that identifies the client or application making the request and is used to determine whether the client has the necessary permissions to access the requested resource.

x-aggregator-id

string

required

Use the x-aggregator-id header to identify the aggregator for a particular request. An aggregator is the entity that is involved in the processing of transactions or data. By including the id in the header, the server can identify which aggregator the request owns and handle the request accordingly.

Responses

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url https://mo-services-zero-production.moprestamo.com/api/v2/customers \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK. A list of customers is returned.

401401

403403

423423