Skip to main content

List Customers API

info

This API is under active development and subject to change.

Path: /v1/list_customers

Send a GET request to this endpoint to get a list of customers that have undergone the qualification flow and their approval status

Request Parameters​

interface ListCustomersRequest {
  secret_api_key: process.env.TRUE_MEDICINE_SECRET_API_KEY;
  cursor: "2022-08-02T22:12:08.877392Z"; // optional
}

Response Parameters​

interface ListCustomersResponse {
  "customers": [
    {
        "email": "[email protected]";
        "name": "John Doe";
        "created_at": "2023-05-30T03:33:09.365574Z";
        "approved_at": "2023-05-30T03:33:09.483343Z";
    },
    {
        "email": "[email protected]";
        "name": null;
        "created_at": "2023-04-18T23:29:16.258502Z";
        "approved_at": null;
    }
  ],
  "cursor": "2023-04-18T23:29:16.258502Z";
}