Qodex.ai

List all customers

GET {{baseUrl}}/customers/

List all Direct Debit customers associated with your account

Request Params

KeyDatatypeRequiredDescription
pagenumberA page number within the paginated result set.
limitnumberIndicates how many results to return per page. By default we return 20 results
per page.

ā„¹ļø The minimum number of results returned per page is 1 and the maximum is 100. If you enter a value greater than 100, our API will default to the maximum value (100). | | search | string | | Return results that match the email, firstname, lastname, or documentNumber you searched for.

Note:

This filter supports both full and partial search queries.

For example, searching for car may match the following values:

  • carlos.vives@musicamexico.mx (email)
  • Carlos (firstname)
  • Cartregena (lastname)
  • 789-CAR-789456789 (documentNumber) |

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"items":[{"id":"3118128a-6792-4b06-bd61-4acf6f6ad6b5","createdDate":"2022-02-09T08:45:50.406032Z","lastUpdatedDate":"2022-02-09T08:45:50.406032Z","firstname":"Carlos","lastname":"Vives","email":"carlos-vives@musica.mx","phone":"+523001234567","country":"mex","documentType":"mx_rfc","documentNumber":"123456789"},{"id":"3118128a-6792-4b06-bd61-4acf6f6ad6b5","createdDate":"2022-02-09T08:45:50.406032Z","lastUpdatedDate":"2022-02-09T08:45:50.406032Z","firstname":"Carlos","lastname":"Vives","email":"carlos-vives@musica.mx","phone":"+523001234567","country":"mex","documentType":"mx_rfc","documentNumber":"123456789"}],"metadata":{"totalItems":100,"itemCount":10,"itemsPerPage":10,"totalPages":10,"currentPage":1},"links":{"first":"/customers?limit=20","last":"/customers?page=4\u0026limit=20","next":"/customers?page=3\u0026limit=20","previous":"/customers?page=2\u0026limit=20"}}