For the complete documentation index, see llms.txt. This page is also available as Markdown.

List Contacts

List contacts.

Use the returned contactId with Get Contact before updating an individual person.

Behaviour

Optionally filter by contact status, companyId, or a case-insensitive search over name and email.

Results are cursor-paginated.

Requires the contacts:read scope.

get
Authorizations
AuthorizationstringRequired

API key sent as a bearer token (mk_live_… / mk_test_…).

Query parameters
limitinteger · min: 1 · max: 5000OptionalDefault: 50
cursorstring · min: 1Optional
statusstring · enumOptionalPossible values:
companyIdstringOptionalPattern: ^COMP-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
searchstring · min: 1Optional
Responses
200

Successful response.

application/json
get/v1/contacts
GET /v1/contacts HTTP/1.1
Host: admin.mimeeqapi.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "data": [
    {
      "contactId": "CONT-123e4567-e89b-12d3-a456-426614174000",
      "contactNumericId": 1,
      "firstName": "text",
      "lastName": "text",
      "companyId": "text",
      "status": "ACTIVE",
      "phoneNumbers": [
        {
          "type": "WORK",
          "number": "text"
        }
      ],
      "emails": [
        {
          "type": "WORK",
          "mail": "text"
        }
      ],
      "isUserAssigned": true,
      "isInvited": true,
      "lastActivityAt": "text",
      "createdAt": "text",
      "modifiedAt": "text"
    }
  ],
  "page": {
    "limit": 1,
    "nextCursor": "text"
  }
}

Last updated

Was this helpful?