List contacts | Modular DS | API documentation

{
  "data": [
    {
      "attributes": {
        "company": null,
        "created_at": "2026-08-10T09:00:00.000000Z",
        "last_name": "Smith",
        "name": "Bob",
        "updated_at": "2026-08-10T09:00:00.000000Z"
      },
      "id": "201",
      "links": {
        "self": "https://api.modulards.com/api/public/v1/contacts/201"
      },
      "type": "contacts"
    }
  ],
  "jsonapi": {
    "version": "1.1"
  },
  "links": {
    "first": "https://api.modulards.com/api/public/v1/contacts?page%5Bnumber%5D=1",
    "last": "https://api.modulards.com/api/public/v1/contacts?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 Contacts the token can reach, one JSON:API resource per Contact, with standard pagination. See the folder description for the full attribute list.

Public filters: id[] (exact contact ids), s (search over name/last_name/company), channel (email|whatsapp).

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

Public includes: contact_methods.

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

Lists the Contacts the token can reach, one JSON:API resource per Contact, with standard pagination. See the folder description for the full attribute list. Public filters: `id[]` (exact contact ids), `s` (search over name/last_name/company), `channel` (`email`|`whatsapp`). Public sorts: `name` (default, ascending), `last_name`, `company`, `created_at` - prefix with `-` for descending. Public includes: `contact_methods`. 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, --prefixed for descending

includestringOptional

contact_methods

filter[id][]stringOptional

Exact contact ids (repeatable)

filter[s]stringOptional

Free-text search over name, last_name, company

filter[channel]stringOptional

email|whatsapp

Response

200 - Contacts

datalist of objectsOptional

jsonapiobjectOptional

linksobjectOptional

metaobjectOptional

Errors

401

Unauthorized Error