> For the complete documentation index, see [llms.txt](https://docs.delos.financial/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.delos.financial/customer/list-customers.md). # List Customers Retrieves a paginated list of customers with filtering options. Returns customer details including balances, status, and metadata. **Endpoint** `GET/v2/customer` **Link** {% embed url="" %} ### **Request** #### **Query Parameters** | Parameter | Type | Description & Values | Required | Example | | ------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ---------------------------------------- | | **`customerId`** | `string` | Filter by customer ID. | No | `"DqCsgSE-4e95-ViYbNI"` | | **`customerName`** | `string` | Filter by customer name (partial match). | No | `"John"` | | **`fromCreateAt`** | `string` | Filter customers created **after** this date (ISO 8601). | No | `"2024-01-01T00:00:00Z"` | | **`meta.page`** | `integer` | Page number (starts from 0). | No | `0` | | **`meta.pageSize`** | `integer` | Items per page. | No | `10` | | **`status`** | `string` |

Filter by customer status:
- NEW: Registered user
- READY\_FOR\_MODERATION: Sent to moderator
- MODERATED: Moderator reviewed
- VERIFY: In verification
- ACCEPT: Approved
- REJECT: Rejected
- BANNED: Blocked

| No | `"ACCEPT"` | | **`toCreateAt`** | `string` | Filter customers created **before** this date (ISO 8601). | No | `"2024-12-31T23:59:59Z"` | | **`type`** | `string` |

Filter by customer type:
- CORPORATE: Business entity
- INDIVIDUAL: Person

| No | `"INDIVIDUAL"` | | **`userUuid`** | `string` | Filter by user UUID. | No | `"b5f8e835-d669-4d4d-8ddf-198263364821"` | *** ### **Response (200 OK)** Returns paginated customer data with metadata. #### **Response Fields** **1. Meta Object** | Field | Type | Description | Example | | -------------- | --------- | ----------------------------------- | ------- | | **`pageSize`** | `integer` | Items per page. | `10` | | **`page`** | `integer` | Current page number. | `0` | | **`total`** | `string` | Total customers (across all pages). | `"150"` | **2. Customer Object (`items[]`)** | Field | Type | Description | Example | | ----------------- | -------- | ------------------------------------------- | ---------------------------------------- | | **`cuid`** | `string` | **Customer unique ID**. | `"DqCsgSE-4e95-ViYbNI"` | | **`puid`** | `string` | **Partner/user ID**. | `"127c9ea7-3ea7-4063-9fa4-c69e796c55e4"` | | **`status`** | `string` | Current status (see values above). | `"ACCEPT"` | | **`createAt`** | `string` | Creation timestamp (ISO 8601). | `"2024-01-15T10:30:00Z"` | | **`updateAt`** | `string` | Last update timestamp (ISO 8601). | `"2024-05-20T14:45:00Z"` | | **`name`** | `string` | First name (individual) or company name. | `"John"` or `"Acme Inc."` | | **`lastname`** | `string` | Last name (individuals only). | `"Doe"` | | **`comment`** | `string` | Internal notes/comments. | `"VIP client"` | | **`company`** | `string` | Company name (if corporate). | `"Acme Inc."` | | **`type`** | `string` | `CORPORATE` or `INDIVIDUAL`. | `"INDIVIDUAL"` | | **`balance`** | `object` | **Available balance** (Money Object). | - | | **`balanceHold`** | `object` | **Held/restricted balance** (Money Object). | - | **Money Object** | Field | Type | Description | Example | | ------------------ | --------- | ------------------------- | --------------------- | | **`currencyCode`** | `string` | Currency code (ISO 4217). | `"USD"` | | **`units`** | `string` | Whole units. | `"1000"` | | **`nanos`** | `integer` | Fractional units (10^-9). | `500000000` (= $0.50) | *** ### **Examples** #### **Request** bash ``` curl -X GET 'https://stagep.tst-apidmndelss.com/v2/customer?status=ACCEPT&type=INDIVIDUAL&meta.page=0&meta.pageSize=5' \ -H 'Authorization: Bearer eyJhbGci...wNLGA' \ -H 'Accept: application/json' ``` #### **Response** json ``` { "meta": { "pageSize": 5, "page": 0, "total": "23" }, "items": [ { "cuid": "DqCsgSE-4e95-ViYbNI", "puid": "127c9ea7-3ea7-4063-9fa4-c69e796c55e4", "status": "ACCEPT", "createAt": "2024-01-15T10:30:00Z", "updateAt": "2024-05-20T14:45:00Z", "name": "John", "lastname": "Doe", "type": "INDIVIDUAL", "balance": { "currencyCode": "USD", "units": "1500", "nanos": 0 }, "balanceHold": { "currencyCode": "USD", "units": "0", "nanos": 0 } } ] } ``` *** ### **Error Responses** 1. **Invalid Status/Type**: json ``` { "error": "Invalid status value: INVALID_STATUS" } ``` 2. **Unauthorized**: json ``` { "error": "Unauthorized" } ``` *** ### **Notes** * **Pagination**: Default `pageSize` is typically 20-50 items. * **Date Format**: Use ISO 8601 (`YYYY-MM-DDThh:mm:ssZ`). * **Balance Types**: * `balance`: Available for transactions. * `balanceHold`: Temporarily locked (e.g., pending transactions). Real request Example 1 ```postman_json Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOjE2NCwiZXhwIjoxNzYxMTMwODI3LCJrZXkiOiI1Y2ZiOGZjN2RmYjk4ZjVkYmIyZTgwNTVkZWFhN2U2Zjk4MzEyYmE3Iiwib3RwX3ZlcmlmaWVkIjpmYWxzZX0.XfGwROoZwOCi3DKim0LItQ1RAUi6tip68ZSLvYNN2_4 customerId: DqCsgSE-4e95-ViYbNI7mudVE customerName: Test com fromCreateAt: string meta.page: integer meta.pageSize: ``` Real response example 1 200 OK ```postman_json { "meta": { "pageSize": 0, "page": 0, "total": "0" }, "items": [] } ``` Real request 2 ```postman_json Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOjE2NCwiZXhwIjoxNzYxMTMwODI3LCJrZXkiOiI1Y2ZiOGZjN2RmYjk4ZjVkYmIyZTgwNTVkZWFhN2U2Zjk4MzEyYmE3Iiwib3RwX3ZlcmlmaWVkIjpmYWxzZX0.XfGwROoZwOCi3DKim0LItQ1RAUi6tip68ZSLvYNN2_4 ``` Real response 2 ```postman_json { "meta": { "pageSize": 22, "page": 0, "total": "22" }, "items": [ { "customerId": "Doief2V-ITMK-rPT6ckmcui5t", "partnerId": "3354815d-1a23-4b1c-81ec-306388cddfa4", "status": "NEW", "createAt": "2025-10-16T17:59:01Z", "updateAt": "2025-10-20T14:07:09Z", "name": "Test", "lastname": "string", "comment": "string", "company": "Test", "type": "CORPORATE", "balance": { "currencyCode": "USD", "units": "0", "nanos": 0 }, "balanceHold": { "currencyCode": "USD", "units": "0", "nanos": 0 } }, { "customerId": "DIekSXG-5nAE-TRioUrRHTW9o", "partnerId": "3354815d-1a23-4b1c-81ec-306388cddfa4", "status": "NEW", "createAt": "2025-10-10T09:09:46Z", "updateAt": "2025-10-10T09:09:46Z", "name": "ABC", "lastname": "", "comment": "", "company": "ABC", "type": "CORPORATE", "balance": { "currencyCode": "USD", "units": "0", "nanos": 0 }, "balanceHold": { "currencyCode": "USD", "units": "0", "nanos": 0 } }, { "customerId": "D7k3xbc-ERrj-lde9k1t3XuaE", "partnerId": "3354815d-1a23-4b1c-81ec-306388cddfa4", "status": "ACCEPT", "createAt": "2025-09-16T11:33:11Z", "updateAt": "2025-10-02T09:03:23Z", "name": "SIRIUS SOLUTIONS LTD", "lastname": "", "comment": "", "company": "SIRIUS SOLUTIONS LTD", "type": "CORPORATE", "balance": { "currencyCode": "USD", "units": "2835", "nanos": 800000002 }, "balanceHold": { "currencyCode": "USD", "units": "3144", "nanos": 199999998 } }, { "customerId": "DsVORph-6e1g-ofLmNlLkSO4e", "partnerId": "3354815d-1a23-4b1c-81ec-306388cddfa4", "status": "NEW", "createAt": "2025-09-16T07:35:45Z", "updateAt": "2025-09-16T07:35:45Z", "name": "Test1", "lastname": "", "comment": "", "company": "Test1", "type": "CORPORATE", "balance": { "currencyCode": "USD", "units": "0", "nanos": 0 }, "balanceHold": { "currencyCode": "USD", "units": "0", "nanos": 0 } }, { "customerId": "DaKFXt2-1vfp-e00RmYfclJTS", "partnerId": "3354815d-1a23-4b1c-81ec-306388cddfa4", "status": "NEW", "createAt": "2025-09-15T08:10:40Z", "updateAt": "2025-09-15T08:10:40Z", "name": "API", "lastname": "App", "comment": "string", "company": "API", "type": "CORPORATE", "balance": { "currencyCode": "USD", "units": "0", "nanos": 0 }, "balanceHold": { "currencyCode": "USD", "units": "0", "nanos": 0 } }, { "customerId": "DuHE6zT-X62B-jlI3z4jDHUbj", "partnerId": "3354815d-1a23-4b1c-81ec-306388cddfa4", "status": "NEW", "createAt": "2025-09-12T10:06:17Z", "updateAt": "2025-10-17T14:34:50Z", "name": "Test", "lastname": "", "comment": "", "company": "Test", "type": "CORPORATE", "balance": { "currencyCode": "USD", "units": "0", "nanos": 0 }, "balanceHold": { "currencyCode": "USD", "units": "0", "nanos": 0 } }, { "customerId": "DKK9ixq-OCO2-s7zsoPNZQMNy", "partnerId": "3354815d-1a23-4b1c-81ec-306388cddfa4", "status": "READY_FOR_MODERATION", "createAt": "2025-04-08T13:18:48Z", "updateAt": "2025-04-08T13:19:44Z", "name": "Test Stage1 Test Stage2", "lastname": "Test Stage2", "comment": "", "company": "Test Stage1 Test Stage2", "type": "CORPORATE", "balance": { "currencyCode": "USD", "units": "0", "nanos": 0 }, "balanceHold": { "currencyCode": "USD", "units": "0", "nanos": 0 } }, { "customerId": "DsXXsPq-NbVT-BSoPIlDF6aWh", "partnerId": "3354815d-1a23-4b1c-81ec-306388cddfa4", "status": "READY_FOR_MODERATION", "createAt": "2025-03-27T06:13:21Z", "updateAt": "2025-03-27T06:36:59Z", "name": "Test1 Test2", "lastname": "Test2", "comment": "Test4", "company": "Test1 Test2", "type": "CORPORATE", "balance": { "currencyCode": "USD", "units": "0", "nanos": 0 }, "balanceHold": { "currencyCode": "USD", "units": "0", "nanos": 0 } }, { "customerId": "D4ZzW7O-USRR-uhNqTZfCtr48", "partnerId": "3354815d-1a23-4b1c-81ec-306388cddfa4", "status": "NEW", "createAt": "2025-03-10T22:19:17Z", "updateAt": "2025-03-10T22:20:30Z", "name": "First Mark 2nd Mark", "lastname": "2nd Mark", "comment": "Comment", "company": "First Mark 2nd Mark", "type": "CORPORATE", "balance": null, "balanceHold": null }, { "customerId": "Ds4chzv-eL2I-M5hvl0Xjv5rX", "partnerId": "3354815d-1a23-4b1c-81ec-306388cddfa4", "status": "NEW", "createAt": "2025-02-25T15:33:31Z", "updateAt": "2025-02-25T15:33:31Z", "name": "TestType4 TestType4", "lastname": "TestType4", "comment": "", "company": "TestType4 TestType4", "type": "INDIVIDUAL", "balance": null, "balanceHold": null }, { "customerId": "DULfTCd-ykEK-7NfYjUE3n4gS", "partnerId": "3354815d-1a23-4b1c-81ec-306388cddfa4", "status": "NEW", "createAt": "2025-02-25T14:59:57Z", "updateAt": "2025-02-25T15:00:04Z", "name": "TestType3 TestType3", "lastname": "TestType3", "comment": "", "company": "TestType3 TestType3", "type": "INDIVIDUAL", "balance": null, "balanceHold": null }, { "customerId": "DN6NzfF-7EhX-GYoVohMqafmM", "partnerId": "3354815d-1a23-4b1c-81ec-306388cddfa4", "status": "NEW", "createAt": "2025-02-25T14:59:21Z", "updateAt": "2025-02-25T14:59:21Z", "name": "TestType2 TestType2", "lastname": "TestType2", "comment": "", "company": "TestType2 TestType2", "type": "CORPORATE", "balance": null, "balanceHold": null }, { "customerId": "DOPnYlY-0Xbl-tcLj2v8svOtx", "partnerId": "3354815d-1a23-4b1c-81ec-306388cddfa4", "status": "NEW", "createAt": "2025-02-14T14:17:30Z", "updateAt": "2025-02-14T14:17:30Z", "name": "Test Test", "lastname": "Test", "comment": "", "company": "Test Test", "type": "CORPORATE", "balance": null, "balanceHold": null }, { "customerId": "Dnewcvn-euuI-vG0FZCRDjLXS", "partnerId": "3354815d-1a23-4b1c-81ec-306388cddfa4", "status": "ACCEPT", "createAt": "2025-01-28T11:10:23Z", "updateAt": "2025-02-14T12:24:01Z", "name": "Test Eugen Test Eugen", "lastname": "Test Eugen", "comment": "Test Eugen", "company": "Test Eugen Test Eugen", "type": "CORPORATE", "balance": { "currencyCode": "USD", "units": "1650", "nanos": 972000225 }, "balanceHold": { "currencyCode": "USD", "units": "498", "nanos": 354814459 } }, { "customerId": "DnCrQVb-u3Tt-fA4rA0bJ47tp", "partnerId": "3354815d-1a23-4b1c-81ec-306388cddfa4", "status": "NEW", "createAt": "2025-01-10T08:58:07Z", "updateAt": "2025-01-10T08:58:07Z", "name": "dfklgjhldfk sruturettring", "lastname": "sruturettring", "comment": "string", "company": "dfklgjhldfk sruturettring", "type": "CORPORATE", "balance": { "currencyCode": "USD", "units": "0", "nanos": 0 }, "balanceHold": { "currencyCode": "USD", "units": "0", "nanos": 0 } }, { "customerId": "DcuswIU-06yY-SWeF4CC6FTeG", "partnerId": "3354815d-1a23-4b1c-81ec-306388cddfa4", "status": "NEW", "createAt": "2025-01-10T08:57:14Z", "updateAt": "2025-01-10T08:57:14Z", "name": "abd ldkfj", "lastname": "ldkfj", "comment": "string", "company": "abd ldkfj", "type": "CORPORATE", "balance": null, "balanceHold": null }, { "customerId": "D4r9r1t-Yv3F-o0elRYoLbDGQ", "partnerId": "3354815d-1a23-4b1c-81ec-306388cddfa4", "status": "NEW", "createAt": "2025-01-10T08:56:04Z", "updateAt": "2025-01-10T08:56:04Z", "name": "Name Lastname", "lastname": "Lastname", "comment": "string", "company": "Name Lastname", "type": "CORPORATE", "balance": null, "balanceHold": null }, { "customerId": "DiIQ7VR-89Cz-MbgvdmhmR2Ic", "partnerId": "3354815d-1a23-4b1c-81ec-306388cddfa4", "status": "NEW", "createAt": "2024-09-18T13:22:05Z", "updateAt": "2024-09-18T13:22:05Z", "name": "Dario Roberts", "lastname": "Roberts", "comment": "Simply. the best", "company": "Dario Roberts", "type": "CORPORATE", "balance": null, "balanceHold": null }, { "customerId": "Drv8xnP-NGrR-opUHqgyIuXW7", "partnerId": "3354815d-1a23-4b1c-81ec-306388cddfa4", "status": "NEW", "createAt": "2024-08-30T11:35:09Z", "updateAt": "2024-08-30T11:36:10Z", "name": "Luca Gorski", "lastname": "Gorski", "comment": "", "company": "Luca Gorski", "type": "CORPORATE", "balance": null, "balanceHold": null }, { "customerId": "DkRyxfy-1pHk-pIJSR7rmQoMY", "partnerId": "3354815d-1a23-4b1c-81ec-306388cddfa4", "status": "NEW", "createAt": "2024-08-20T11:20:02Z", "updateAt": "2024-08-20T11:20:02Z", "name": "Mark Walsh", "lastname": "Walsh", "comment": "Client 1 onboarded 20th August", "company": "Mark Walsh", "type": "CORPORATE", "balance": null, "balanceHold": null }, { "customerId": "DoxdEEV-4IJq-zKeUYqrtqVDK", "partnerId": "3354815d-1a23-4b1c-81ec-306388cddfa4", "status": "NEW", "createAt": "2024-08-15T13:07:55Z", "updateAt": "2024-08-15T13:07:55Z", "name": "James Test", "lastname": "Test", "comment": "", "company": "James Test", "type": "CORPORATE", "balance": null, "balanceHold": null }, { "customerId": "D2m7Lul-43rP-DdkoWBYZuZrn", "partnerId": "3354815d-1a23-4b1c-81ec-306388cddfa4", "status": "READY_FOR_MODERATION", "createAt": "2024-08-14T13:09:28Z", "updateAt": "2025-02-25T14:58:59Z", "name": "Test Test", "lastname": "Test", "comment": "Test", "company": "Test Test", "type": "INDIVIDUAL", "balance": { "currencyCode": "USD", "units": "-120", "nanos": -340000000 }, "balanceHold": { "currencyCode": "USD", "units": "220", "nanos": 340000000 } } ] } ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.delos.financial/customer/list-customers.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.