List clients

GET

https://api.modulards.com/api/public/v1/clients

GET

/api/public/v1/clients

curl https://api.modulards.com/api/public/v1/clients \
     -H "Authorization: Bearer <token>"

200200 - Clients

{
  "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,
    "links": [
      {
        "active": false,
        "label": "&laquo; Previous",
        "url": null
      },
      {
        "active": true,
        "label": "1",
        "url": "https://api.modulards.com/api/public/v1/clients?page%5Bnumber%5D=1"
      },
      {
        "active": false,
        "label": "Next &raquo;",
        "url": null
      }
    ],
    "path": "https://api.modulards.com/api/public/v1/clients",
    "per_page": 15,
    "to": 1,
    "total": 1
  }
}

Lists the clients you can reach. Use it to find a client by name or company, to see which clients have a given website, or to build a directory of your customers.

By default clients come sorted by name. You can also get each client’s number of websites, which counts only the websites your token can reach, and add the client’s contact methods or websites to the answer with include.

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 number, starting at 1.

page[size]stringOptional

Rows per page, up to 50 (default 15).

sortstringOptional

Sort order. Accepted: name, last_name, company, created_at, sites_count; a leading - reverses the order. Default name, ascending.

includestringOptional

Related data to return with each client. Accepted: contact_methods and sites. Separate several with commas.

fields[clients]stringOptional

Limits the attributes returned. sites_count, the number of websites your token can reach, is only returned when you name it here or sort by it.

filter[id][]stringOptional

Only these clients, by client id. Several ids match any of them.

filter[s]stringOptional

Free-text search over the name, the last name and the company.

filter[sites][]stringOptional

Only the clients assigned to these websites, by website id. Several ids match any of them.

filter[channel]stringOptional

Only the clients that have a contact method on this channel: email or phone.

Response

200 - Clients

datalist of objectsOptional

jsonapiobjectOptional

linksobjectOptional

metaobjectOptional