List contacts

GET

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

GET

/api/public/v1/contacts

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

200200 - Contacts

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

Lists the contacts you can reach. Use it to find a recipient by name or company, or to check who already has an email or a WhatsApp number before adding them to a notification configuration.

By default contacts come sorted by name. Add each contact’s contact methods 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; a leading - reverses the order. Default name, ascending.

includestringOptional

Related data to return with each contact. Accepted: contact_methods.

filter[id][]stringOptional

Only these contacts, by contact id. Several ids match any of them.

filter[s]stringOptional

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

filter[channel]stringOptional

Only the contacts that have a contact method on this channel: email or whatsapp.

Response

200 - Contacts

datalist of objectsOptional

jsonapiobjectOptional

linksobjectOptional

metaobjectOptional