List clients | Modular DS | API documentation

{
  "data": [
    {
      "attributes": {
        "company": "Acme",
        "created_at": "2026-08-10T09:00:00.000000Z",
        "last_name": "Walker",
        "name": "Alice",
        "updated_at": "2026-08-10T09:00:00.000000Z"
      },
      "id": "101",
      "links": {
        "self": "https://api.modulards.com/api/public/v1/clients/101"
      },
      "type": "clients"
    }
  ],
  "jsonapi": {
    "version": "1.1"
  },
  "links": {
    "first": "https://api.modulards.com/api/public/v1/clients?page%5Bnumber%5D=1",
    "last": "https://api.modulards.com/api/public/v1/clients?page%5Bnumber%5D=1",
    "next": null,
    "prev": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "per_page": 15,
    "to": 1,
    "total": 1
  }
}

Lists the Clients the token can reach, one JSON:API resource per Client, with standard pagination. See the folder description for the full attribute list.

Public filters: id[] (exact client ids), s (search over name/last_name/company), sites[] (website ids), channel (email|phone).

Public sorts: name (default, ascending), last_name, company, created_at, sites_count - prefix with - for descending.

Public includes: contact_methods, sites.

sites_count is computed: request it with fields[clients]=sites_count (or sort by it) - it counts only the websites the acting member can reach.

Default page size is 15, capped at 50 (page[size]). A read-only token is enough.

Lists the Clients the token can reach, one JSON:API resource per Client, with standard pagination. See the folder description for the full attribute list. Public filters: `id[]` (exact client ids), `s` (search over name/last_name/company), `sites[]` (website ids), `channel` (`email`|`phone`). Public sorts: `name` (default, ascending), `last_name`, `company`, `created_at`, `sites_count` - prefix with `-` for descending. Public includes: `contact_methods`, `sites`. `sites_count` is computed: request it with `fields[clients]=sites_count` (or sort by it) - it counts only the websites the acting member can reach. Default page size is 15, capped at 50 (`page[size]`). A read-only token is enough.

Authentication

AuthorizationBearer

Personal access token created in the Modular DS dashboard; read-only tokens can only call GET endpoints.

Query parameters

page[number]stringOptional

page[size]stringOptional

Max 50, default 15

sortstringOptional

name (default, ascending) | last_name | company | created_at | sites_count, --prefixed for descending

includestringOptional

contact_methods | sites

fields[clients]stringOptional

sparse fieldset; sites_count is computed and only appears when named here or used to sort

filter[id][]stringOptional

Exact client ids (repeatable)

filter[s]stringOptional

Free-text search over name, last_name, company

filter[sites][]stringOptional

Exact website ids (repeatable)

filter[channel]stringOptional

email|phone

Response

200 - Clients

datalist of objectsOptional

jsonapiobjectOptional

linksobjectOptional

metaobjectOptional

Errors

401

Unauthorized Error