Filmo Docs
Español

Contacts

List contacts

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

GET
/api/v1/contacts

Request examples

curl https://app.filmo.io/api/v1/contacts \
  --header "Authorization: Bearer $FILMO_API_KEY"
{
  "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
  }
}

Generated from the schema

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

Authorizations

Bearer API key with the scope below. contacts:read

Query parameters

limitintegerdefault:50

Page size (1-500). Defaults to 50.

Limits: min 1, max 500

cursorstring

Opaque cursor of the page to return. Pass the value of pagination.nextCursor from the previous response; treat it as opaque.

Limits: max length 200

createdOnstring

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.

Limits: pattern ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$

createdAfterstring

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.

Limits: pattern ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$

createdBeforestring

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.

Limits: pattern ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$

createdFromstring

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.

Limits: pattern ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$

createdTostring

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.

Limits: pattern ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$

updatedOnstring

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.

Limits: pattern ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$

updatedAfterstring

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.

Limits: pattern ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$

updatedBeforestring

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.

Limits: pattern ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$

updatedFromstring

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.

Limits: pattern ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$

updatedTostring

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.

Limits: pattern ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$

sortstring

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.

Limits: max length 200

typestring

Filter by contact type: person (individual) or company (business).

Available options: person, company

rolestring

Filter by contact role: client, provider, lead, debtor, creditor, student, teacher or unspecified.

Available options: client, provider, lead, debtor, creditor, student, teacher, unspecified

emailstring

Filter by email: matches against the email addresses of the contact.

Limits: max length 200

phonestring

Filter by phone: matches against the phone numbers of the contact.

Limits: max length 200

isAppUserboolean

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.

includeTotalbooleandefault:false

Set it to true to include pagination.total, the number of results that match the filters across all pages. Off by default.

Response

application/json

Successful response.

Response schema: ContactDto

Envelope: ContactList. meta.warnings is present only when the operation is deprecated.

Headers: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset

dataobject[]

Show child attributes
data.idstring

Unique identifier of the contact.

data.namestring

Contact name (person or company).

data.contactTypestring

Contact type: person (individual) or company (business).

Available options: person, company

data.rolestring

Contact role: client, provider, lead, debtor, creditor, student, teacher or unspecified.

Available options: client, provider, lead, debtor, creditor, student, teacher, unspecified

data.statusstring

Contact status: active (operational), inactive (deactivated) or archived (closed, kept for historical records).

Available options: active, inactive, archived

data.nifstring | null

NIF/CIF or tax identification number; null if not recorded.

data.commercialNamestring | null

Trade name; null if it matches the name or is not recorded.

data.positionstring | null

Job title or position of the contact person; null if not recorded.

data.contactNumberstring | null

Contact number assigned by the account (internal reference); null if not recorded.

data.emailsobject[]

List of email addresses of the contact.

Show child attributes
data.emails.idstring

Internal identifier of the email within the contact.

data.emails.labelstring | null

Descriptive label of the email; null if it has none.

data.emails.emailstring

Email address.

data.emails.isPrimaryboolean

Whether this is the primary email of the contact.

data.billingEmailstring | null

Dedicated billing email; null means the primary email is used.

data.phoneNumbersobject[]

List of phone numbers of the contact.

Show child attributes
data.phoneNumbers.idstring

Internal identifier of the phone number within the contact.

data.phoneNumbers.labelstring | null

Descriptive label of the phone number; null if it has none.

data.phoneNumbers.numberstring

Phone number.

data.phoneNumbers.countryCodestring | null

International country calling code (e.g. "+34"); null if not recorded.

data.phoneNumbers.isPrimaryboolean

Whether this is the primary phone number of the contact.

data.websitesobject[]

List of websites of the contact.

Show child attributes
data.websites.idstring

Internal identifier of the website within the contact.

data.websites.labelstring | null

Descriptive label of the website; null if it has none.

data.websites.urlstring

Website URL.

data.addressesobject[]

List of addresses of the contact.

Show child attributes
data.addresses.idstring

Internal identifier of the address within the contact.

data.addresses.labelstring | null

Descriptive label of the address; null if it has none.

data.addresses.addressLine1string | null

First line of the address; null if not recorded.

data.addresses.addressLine2string | null

Second line of the address; null if not recorded.

data.addresses.citystring | null

City; null if not recorded.

data.addresses.provincestring | null

Province or region; null if not recorded.

data.addresses.postcodestring | null

Postcode; null if not recorded.

data.addresses.countrystring | null

Country; null if not recorded.

data.addresses.isMainboolean

Whether this is the main address of the contact.

data.folderstring | null

Folder or organizational grouping; null if the contact is not classified.

data.discountPercentagenumber | null

General discount percentage of the contact (0-100); null if no discount is configured.

data.preferredLanguagestring | null

Preferred language of the contact; null if not recorded.

data.currencystring | null

Default currency of the contact as an ISO 4217 code; null if not recorded.

data.paymentMethodobject | null

Preferred payment method of the contact; null if not configured.

Show child attributes
data.paymentMethod.typestring

Payment method type: bank_transfer, card, cash, sepa_direct_debit or other.

Available options: bank_transfer, card, cash, other, sepa_direct_debit

data.paymentMethod.customValuestring | null

Free-text detail when the type is "other" (for example a method recorded before it was configured); null otherwise.

data.paymentDaysinteger[] | null

Days of the month on which the contact makes payments; null if not configured.

data.expirationDaysinteger | null

Default due days for the invoices of the contact; null if not configured.

data.subscribedToMarketingboolean

Whether the contact is subscribed to marketing communications.

data.isAppUserboolean

Whether the contact has access to the app.

data.customFieldsobject<string, any>

Custom field values by custom field identifier; the definitions are in /api/v1/custom-fields.

data.createdAtstring<date-time>

Creation date in ISO 8601 with offset.

data.updatedAtstring<date-time>

Last update date in ISO 8601 with offset.

paginationobject

Opaque-cursor pagination metadata.

Show child attributes
pagination.nextCursorstring | null

Opaque cursor of the next page; null when there are no more results. Pass it as cursor in the next request.

pagination.hasMoreboolean

Whether more results exist beyond this page.

pagination.totalinteger

Number of results matching the filters across all pages. Present only when the request sets includeTotal=true.

Limits: min 0

metaobject

Additional information about the response.

Show child attributes
meta.warningsobject[]

Lifecycle warnings; present only when the operation is deprecated.

Show child attributes
meta.warnings.codestring

Stable warning code.

Available options: deprecated

meta.warnings.messagestring

For people: what is deprecated, until when, and what to use.

meta.warnings.sunsetstring

Day (YYYY-MM-DD) the operation stops being served.

meta.warnings.replacementstring | null

operationId of the operation to use instead, or null if there is none.

meta.warnings.linkstring

Where the deprecation is documented (the changelog).

Errors

StatusCodesMeaning
400validation_errorMalformed query or body. errors[] lists every offending field with its stable code.

401, 403, 429, 500 can be returned by any operation. Errors

Deprecation

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

Related

Related pages

Link to this section: Related pages

  • CRM

    Contact

    The contact, as returned by the API.

Was this page helpful?

Cookies

If you accept, we use Google cookies to measure visits and show you ads. Privacy policy

More information

With your consent we use Google Ads and Google Analytics cookies to measure which campaigns bring visitors and requests, and to show you Filmo ads on other sites. Without acceptance, Google receives cookieless measurement signals, including your IP address, browser information and a cleaned page URL. Your choice is shared with the Filmo app.