*REST API › Endpoint reference › CRM › Contacts*

# List contacts

> Returns the contacts (customers and suppliers) visible to the key, cursor-paginated.

Tenancy inherited from the parent account: a billing account also sees the contacts of its parent account.

`GET /api/v1/contacts` — scope `contacts:read`

Scope: `contacts:read` · 120/min · Inherited tenancy · MCP: `filmo_contacts_list`

## Authorizations

Bearer API key with the scope below. `contacts:read`

## Query parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `limit` | integer | No | Page size (1-500). Defaults to 50. = `50` |
| `cursor` | string | No | Opaque cursor of the page to return. Pass the value of `pagination.nextCursor` from the previous response; treat it as opaque. |
| `createdOn` | string | No | The creation date of the resource falls on this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset. |
| `createdAfter` | string | No | The creation date of the resource is after this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset. |
| `createdBefore` | string | No | The creation date of the resource is before this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset. |
| `createdFrom` | string | No | The creation date of the resource is on or after this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset. |
| `createdTo` | string | No | The creation date of the resource is on or before this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset. |
| `updatedOn` | string | No | The last update date of the resource falls on this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset. |
| `updatedAfter` | string | No | The last update date of the resource is after this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset. |
| `updatedBefore` | string | No | The last update date of the resource is before this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset. |
| `updatedFrom` | string | No | The last update date of the resource is on or after this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset. |
| `updatedTo` | string | No | The last update date of the resource is on or before this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset. |
| `sort` | string | No | Sort order: up to 3 comma-separated fields, each with a leading "-" for descending (e.g. "-updatedAt,name"). Sortable fields: createdAt, updatedAt, name, contactType, role, status, email. Defaults to "-createdAt". Ties are broken by id, so the order is stable across pages, and a cursor is bound to the sort it was issued with. |
| `type` | string | No | Filter by contact type: person (individual) or company (business). `person`, `company` |
| `role` | string | No | Filter by contact role: client, provider, lead, debtor, creditor, student, teacher or unspecified. `client`, `provider`, `lead`, `debtor`, `creditor`, `student`, `teacher`, `unspecified` |
| `email` | string | No | Filter by email: matches against the email addresses of the contact. |
| `phone` | string | No | Filter by phone: matches against the phone numbers of the contact. |
| `isAppUser` | boolean | No | Filter by whether the contact has access to the app: "true" returns only app users, "false" only those who are not. Omit it to skip the filter. |
| `includeTotal` | boolean | No | Set it to true to include `pagination.total`, the number of results that match the filters across all pages. Off by default. = `false` |

## Request examples

*List contacts*

**cURL**

```bash
curl https://app.filmo.io/api/v1/contacts \
  --header "Authorization: Bearer $FILMO_API_KEY"
```

**Node.js**

```javascript
fetch('https://app.filmo.io/api/v1/contacts', {
  headers: {
    Authorization: 'Bearer YOUR_FILMO_API_KEY'
  }
})
```

**Python**

```python
import requests

requests.get("https://app.filmo.io/api/v1/contacts",
    headers={
      "Authorization": "Bearer YOUR_FILMO_API_KEY"
    }
)
```

## Response

Response schema: `ContactDto`

| Status | Description |
| --- | --- |
| 200 | Successful response. |
| 400 | Invalid request (validation_error): malformed query or body. `errors[]` lists every offending field with its stable code. |
| 401 | Authentication failed (unauthorized, api_key_invalid, api_key_revoked, api_key_expired, api_key_owner_inactive, api_key_owner_not_admin). |
| 403 | Not allowed (insufficient_scope: the API key does not have the required scope, named in `requiredScope`; forbidden: the owner of the key lacks the permission the operation requires). `insufficient_scope` is answered before the request counts against the rate limit, so it carries no `RateLimit-*` headers; `forbidden` does. |
| 429 | Rate limit exceeded (rate_limited): retry after `Retry-After` seconds; `RateLimit-*` says which quota ran out. |
| 500 | Internal error (internal_error). |

**200**

| Name | Type | Description |
| --- | --- | --- |
| `data` | object[] |  |
| `data.id` | string | Unique identifier of the contact. |
| `data.name` | string | Contact name (person or company). |
| `data.contactType` | string | Contact type: person (individual) or company (business). `person`, `company` |
| `data.role` | string | Contact role: client, provider, lead, debtor, creditor, student, teacher or unspecified. `client`, `provider`, `lead`, `debtor`, `creditor`, `student`, `teacher`, `unspecified` |
| `data.status` | string | Contact status: active (operational), inactive (deactivated) or archived (closed, kept for historical records). `active`, `inactive`, `archived` |
| `data.nif` | string | NIF/CIF or tax identification number; null if not recorded. |
| `data.commercialName` | string | Trade name; null if it matches the name or is not recorded. |
| `data.position` | string | Job title or position of the contact person; null if not recorded. |
| `data.contactNumber` | string | Contact number assigned by the account (internal reference); null if not recorded. |
| `data.emails` | object[] | List of email addresses of the contact. |
| `data.emails.id` | string | Internal identifier of the email within the contact. |
| `data.emails.label` | string | Descriptive label of the email; null if it has none. |
| `data.emails.email` | string | Email address. |
| `data.emails.isPrimary` | boolean | Whether this is the primary email of the contact. |
| `data.billingEmail` | string | Dedicated billing email; null means the primary email is used. |
| `data.phoneNumbers` | object[] | List of phone numbers of the contact. |
| `data.phoneNumbers.id` | string | Internal identifier of the phone number within the contact. |
| `data.phoneNumbers.label` | string | Descriptive label of the phone number; null if it has none. |
| `data.phoneNumbers.number` | string | Phone number. |
| `data.phoneNumbers.countryCode` | string | International country calling code (e.g. "+34"); null if not recorded. |
| `data.phoneNumbers.isPrimary` | boolean | Whether this is the primary phone number of the contact. |
| `data.websites` | object[] | List of websites of the contact. |
| `data.websites.id` | string | Internal identifier of the website within the contact. |
| `data.websites.label` | string | Descriptive label of the website; null if it has none. |
| `data.websites.url` | string | Website URL. |
| `data.addresses` | object[] | List of addresses of the contact. |
| `data.addresses.id` | string | Internal identifier of the address within the contact. |
| `data.addresses.label` | string | Descriptive label of the address; null if it has none. |
| `data.addresses.addressLine1` | string | First line of the address; null if not recorded. |
| `data.addresses.addressLine2` | string | Second line of the address; null if not recorded. |
| `data.addresses.city` | string | City; null if not recorded. |
| `data.addresses.province` | string | Province or region; null if not recorded. |
| `data.addresses.postcode` | string | Postcode; null if not recorded. |
| `data.addresses.country` | string | Country; null if not recorded. |
| `data.addresses.isMain` | boolean | Whether this is the main address of the contact. |
| `data.folder` | string | Folder or organizational grouping; null if the contact is not classified. |
| `data.discountPercentage` | number | General discount percentage of the contact (0-100); null if no discount is configured. |
| `data.preferredLanguage` | string | Preferred language of the contact; null if not recorded. |
| `data.currency` | string | Default currency of the contact as an ISO 4217 code; null if not recorded. |
| `data.paymentMethod` | object | Preferred payment method of the contact; null if not configured. |
| `data.paymentMethod.type` | string | Payment method type: bank_transfer, card, cash, sepa_direct_debit or other. `bank_transfer`, `card`, `cash`, `other`, `sepa_direct_debit` |
| `data.paymentMethod.customValue` | string | Free-text detail when the type is "other" (for example a method recorded before it was configured); null otherwise. |
| `data.paymentDays` | integer[] | Days of the month on which the contact makes payments; null if not configured. |
| `data.expirationDays` | integer | Default due days for the invoices of the contact; null if not configured. |
| `data.subscribedToMarketing` | boolean | Whether the contact is subscribed to marketing communications. |
| `data.isAppUser` | boolean | Whether the contact has access to the app. |
| `data.customFields` | object<string, any> | Custom field values by custom field identifier; the definitions are in `/api/v1/custom-fields`. |
| `data.createdAt` | string<date-time> | Creation date in ISO 8601 with offset. |
| `data.updatedAt` | string<date-time> | Last update date in ISO 8601 with offset. |
| `pagination` | object | Opaque-cursor pagination metadata. |
| `pagination.nextCursor` | string | Opaque cursor of the next page; null when there are no more results. Pass it as `cursor` in the next request. |
| `pagination.hasMore` | boolean | Whether more results exist beyond this page. |
| `pagination.total` | integer | Number of results matching the filters across all pages. Present only when the request sets `includeTotal=true`. |
| `meta` | object | Additional information about the response. |
| `meta.warnings` | object[] | Lifecycle warnings; present only when the operation is deprecated. |
| `meta.warnings.code` | string | Stable warning code. `deprecated` |
| `meta.warnings.message` | string | For people: what is deprecated, until when, and what to use. |
| `meta.warnings.sunset` | string | Day (YYYY-MM-DD) the operation stops being served. |
| `meta.warnings.replacement` | string | `operationId` of the operation to use instead, or null if there is none. |
| `meta.warnings.link` | string | Where the deprecation is documented (the changelog). |

*Example response · 200*

```json
{
  "data": [
    {
      "id": "contact_9f3a2b",
      "name": "Example contact",
      "contactType": "person",
      "role": "client",
      "status": "active",
      "nif": "B00000000",
      "commercialName": "Example commercial name",
      "position": "Example position",
      "contactNumber": "2026-0001",
      "emails": [
        {
          "id": "email_9f3a2b",
          "label": "Main",
          "email": "ana.garcia@example.com",
          "isPrimary": true
        }
      ],
      "billingEmail": "ana.garcia@example.com",
      "phoneNumbers": [
        {
          "id": "phone_number_9f3a2b",
          "label": "Main",
          "number": "+34 600 000 000",
          "countryCode": "+34",
          "isPrimary": true
        }
      ],
      "websites": [
        {
          "id": "website_9f3a2b",
          "label": "Main",
          "url": "https://example.com/resource"
        }
      ],
      "addresses": [
        {
          "id": "address_9f3a2b",
          "label": "Main",
          "addressLine1": "Calle de Ejemplo 12",
          "addressLine2": "Calle de Ejemplo 12",
          "city": "Madrid",
          "province": "Madrid",
          "postcode": "28001",
          "country": "ES",
          "isMain": true
        }
      ],
      "folder": "Example folder",
      "discountPercentage": 1,
      "preferredLanguage": "es-ES",
      "currency": "EUR",
      "paymentMethod": {
        "type": "bank_transfer",
        "customValue": "Example custom value"
      },
      "paymentDays": [
        1
      ],
      "expirationDays": 1,
      "subscribedToMarketing": true,
      "isAppUser": true,
      "customFields": {
        "example": "example"
      },
      "createdAt": "2026-09-01T08:00:00.000Z",
      "updatedAt": "2026-09-01T08:00:00.000Z"
    }
  ],
  "pagination": {
    "nextCursor": "eyJvIjoyMH0",
    "hasMore": true,
    "total": 1
  }
}
```

## Errors

| Status | Codes | Meaning |
| --- | --- | --- |
| 400 | `validation_error` | Malformed query or body. `errors[]` lists every offending field with its stable code. |

## Deprecation

This operation is not deprecated. Deprecations are announced with a Deprecation header and a sunset date.

---

Canonical URL: https://docs.filmo.io/rest-api/endpoint-reference/contacts/list-contacts  
Last updated: 2026-10-25