CRM

Contact

The contact, as returned by the API.

Schemas: ContactDto, ContactDetailDto

{
  "id": "id_8f2a1c",
  "name": "Example",
  "contactType": "person",
  "role": "client",
  "status": "active",
  "nif": "00000000T",
  "commercialName": "Example",
  "position": "string",
  "contactNumber": "string",
  "emails": [
    {
      "id": "id_8f2a1c",
      "label": "Example",
      "email": "ana@example.com",
      "isPrimary": true
    }
  ],
  "billingEmail": "ana@example.com",
  "phoneNumbers": [
    {
      "id": "id_8f2a1c",
      "label": "Example",
      "number": "string",
      "countryCode": "ES",
      "isPrimary": true
    }
  ],
  "websites": [
    {
      "id": "id_8f2a1c",
      "label": "Example",
      "url": "https://example.com"
    }
  ],
  "addresses": [
    {
      "id": "id_8f2a1c",
      "label": "Example",
      "addressLine1": "string",
      "addressLine2": "string",
      "city": "string",
      "province": "string",
      "postcode": "string",
      "country": "ES",
      "isMain": true
    }
  ],
  "folder": "string",
  "discountPercentage": 1,
  "preferredLanguage": "es-ES",
  "currency": "EUR",
  "paymentMethod": {
    "type": "bank_transfer",
    "customValue": "string"
  },
  "paymentDays": [
    1
  ],
  "expirationDays": 1,
  "subscribedToMarketing": true,
  "isAppUser": true,
  "customFields": {
    "key": "string"
  },
  "createdAt": "2026-09-01T08:00:00Z",
  "updatedAt": "2026-09-01T08:00:00Z",
  "relatedContacts": [
    {
      "id": "id_8f2a1c",
      "name": "Example",
      "commercialName": "Example",
      "contactType": "person",
      "role": "client",
      "status": "active",
      "relationRole": "string"
    }
  ]
}

Generated from the schema

A customer or a supplier of the account, with its tax data, emails, phone numbers, addresses and commercial terms. Orders, quotes, invoices and projects point to a contact. Contacts use the tenancy inherited from the parent account, so a billing account also sees the contacts of its parent. contactNumber is writable (up to 50 characters) but it is not unique and Filmo does not generate it. The detail read, GET /api/v1/contacts/{contactId}, adds the related contacts, which the list does not carry.

Attributes

idstring

Unique identifier of the contact.

namestring

Contact name (person or company).

contactTypestring

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

Available options: person, company

rolestring

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

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

statusstring

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

Available options: active, inactive, archived

nifstring | null

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

commercialNamestring | null

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

positionstring | null

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

contactNumberstring | null

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

emailsobject[]

List of email addresses of the contact.

Show child attributes

emails.idstring

Internal identifier of the email within the contact.

emails.labelstring | null

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

emails.emailstring

Email address.

emails.isPrimaryboolean

Whether this is the primary email of the contact.

billingEmailstring | null

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

phoneNumbersobject[]

List of phone numbers of the contact.

Show child attributes

phoneNumbers.idstring

Internal identifier of the phone number within the contact.

phoneNumbers.labelstring | null

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

phoneNumbers.numberstring

Phone number.

phoneNumbers.countryCodestring | null

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

phoneNumbers.isPrimaryboolean

Whether this is the primary phone number of the contact.

websitesobject[]

List of websites of the contact.

Show child attributes

websites.idstring

Internal identifier of the website within the contact.

websites.labelstring | null

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

websites.urlstring

Website URL.

addressesobject[]

List of addresses of the contact.

Show child attributes

addresses.idstring

Internal identifier of the address within the contact.

addresses.labelstring | null

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

addresses.addressLine1string | null

First line of the address; null if not recorded.

addresses.addressLine2string | null

Second line of the address; null if not recorded.

addresses.citystring | null

City; null if not recorded.

addresses.provincestring | null

Province or region; null if not recorded.

addresses.postcodestring | null

Postcode; null if not recorded.

addresses.countrystring | null

Country; null if not recorded.

addresses.isMainboolean

Whether this is the main address of the contact.

folderstring | null

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

discountPercentagenumber | null

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

preferredLanguagestring | null

Preferred language of the contact; null if not recorded.

currencystring | null

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

paymentMethodobject | null

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

Show child attributes

paymentMethod.typestring

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

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

paymentMethod.customValuestring | null

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

paymentDaysinteger[] | null

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

expirationDaysinteger | null

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

subscribedToMarketingboolean

Whether the contact is subscribed to marketing communications.

isAppUserboolean

Whether the contact has access to the app.

customFieldsobject<string, any>

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

createdAtstring<date-time>

Creation date in ISO 8601 with offset.

updatedAtstring<date-time>

Last update date in ISO 8601 with offset.

relatedContactsobject[]only in the detail

Contacts related to this contact (e.g. people of a company).

Show child attributes

relatedContacts.idstring

Unique identifier of the related contact.

relatedContacts.namestring

Name of the related contact.

relatedContacts.commercialNamestring | null

Trade name of the related contact; null if not recorded.

relatedContacts.contactTypestring

Type of the related contact: person or company.

Available options: person, company

relatedContacts.rolestring

Role of the related contact.

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

relatedContacts.statusstring

Status of the related contact: active, inactive or archived.

Available options: active, inactive, archived

relatedContacts.relationRolestring | null

Role of the relationship between the two contacts (e.g. "employee of"); null if not recorded.

Values

contactType: person, company
role: client, provider, lead, debtor, creditor, student, teacher, unspecified
status: active, inactive, archived

Returned by

GET /api/v1/contacts — List contacts
GET /api/v1/contacts/{contactId} — Get a contact

Modified by

POST /api/v1/contacts — Create a contact
PATCH /api/v1/contacts/{contactId} — Update a contact
PATCH /api/v1/contacts/{contactId}/preferences — Update the commercial terms of a contact
POST /api/v1/contacts/{contactId}/addresses — Add an address to a contact
PATCH /api/v1/contacts/{contactId}/addresses/{addressId} — Update an address of a contact
DELETE /api/v1/contacts/{contactId}/addresses/{addressId} — Remove an address from a contact
POST /api/v1/contacts/{contactId}/related-contacts — Relate two contacts
PATCH /api/v1/contacts/{contactId}/related-contacts/{relatedContactId} — Change the role of a relationship
DELETE /api/v1/contacts/{contactId}/related-contacts/{relatedContactId} — Unrelate two contacts

Was this page helpful?