List Customers

Returns the list of customers across all your workspaces with pagination and filtering options.

GET https://api.platica.mx/v1/clients

Query parameters

Parameter	Type	Description	Required
`limit`	number	Maximum customers in the response. Maximum: `200`. Default: `50`	—
`pageToken`	string	`nextPageToken` cursor from the previous response. Preferred over `offset`. Cannot be combined with `offset`, and is invalidated if you change the filters or the sort	—
`offset`	number	Number of records to skip. Legacy alternative to `pageToken`; capped at `100000`	—
`sortBy`	enum	Field to sort by: `name` (default) or `creationDate`	—
`sortDirection`	enum	Sort direction: `asc` (default) or `desc`	—
`status`	enum	Filter by status: `active` or `blocked`. `active` includes customers that never had an explicit status	—
`searchTerm`	string	Reserved. Accepted but does not filter results yet	—
`tags`	array	List of tags to filter by	—
`dateFilter`	object	Filter by date or period	—

Specific date:

GET /v1/clients?dateFilter={"type":"specific","date":"2024-01-15"}

Date range:

GET /v1/clients?dateFilter={"type":"range","startDate":"2024-01-01","endDate":"2024-01-31"}

The listing returns status but not the full moderation object — use Get a Customer for that.

Response

{
  "workspaces": [
    {
      "id": "g6yCA16pkWl5eXo7KszB",
      "name": "ws_1",
      "clients": [
        {
          "id": "167b545fcde641dcb319eca0cc4d7b0f",
          "phoneNumber": "12345678910",
          "name": "José",
          "firstname": "José",
          "lastname": "García",
          "email": "jose@empresa.com",
          "birthdate": null,
          "gender": "male",
          "company": null,
          "country": "MX",
          "state": "Michoacán",
          "city": "Morelia",
          "address": null,
          "postalCode": null,
          "status": "active",
          "tags": [],
          "owners": ["user1@company.com", "user2@company.com"],
          "customFields": {
            "placas": "",
            "id_recepcion": "",
            "fecha_siniestro": ""
          },
          "creationDate": "2025-02-06T16:45:50.146Z",
          "lastUpdate": "2025-02-06T16:45:50.146Z"
        }
      ],
      "clientsCount": 1,
      "pagination": {
        "limit": 50,
        "offset": 0,
        "hasMore": true
      }
    }
  ],
  "nextPageToken": "eyJ2IjoxLCJxIjoiYTFi..."
}

Response fields

Field	Description
`id`	Internal customer ID
`phoneNumber`	Customer phone number without the `+` prefix
`name`	Customer full name
`firstname`	Customer first name
`lastname`	Customer last name
`email`	Email address
`birthdate`	Date of birth
`gender`	Gender
`company`	Company name
`country`	Country of residence
`state`	State of residence
`city`	City of residence
`address`	Full address
`postalCode`	Postal code
`status`	Customer status: `active` or `blocked`
`tags`	Tags associated with the customer
`owners`	List of responsible-user emails
`customFields`	Customer custom fields
`creationDate`	Creation date in ISO 8601 format
`lastUpdate`	Last update date in ISO 8601 format

Pagination fields

Field	Description
`clientsCount`	Total number of customers returned for that workspace
`pagination.limit`	Maximum number of results requested
`pagination.offset`	Number of results skipped
`pagination.hasMore`	Indicates whether more results exist in that workspace
`nextPageToken`	Cursor to request the next page; `null` when no results are left. A single token covers every workspace the key can read, which is why it sits at the root instead of inside each one

Previous Introduction Next Get a Customer