FAfactorialhr
Finance > Contact

Reads all Contacts

Changed on

Reads all Contacts

get/api/2026-10-01/resources/finance/contacts

Request

  • Base URL
    https://api.factorialhr.com
  • URL
    https://api.factorialhr.com/api/2026-10-01/resources/finance/contacts
  • Auth
    • OAuth 2
      Authorization code: https://id.factorialhr.com/oauth/authorize
      Token URL: https://id.factorialhr.com/api/oauth/token scopes: finance
    • or API key in header x-api-key

Query parameters

ids[]string[]

List of Contact IDs to filter by.

[
  "123",
  "456"
]
tax_ids[]string[]

List of Tax IDs to filter by.

[
  "X1234567",
  "B7654321"
]
legal_namestring

Filter by partial match of a contact's legal name.

Example:Google
namestring

The commercial name of the Contact.

Example:Google
contact_type'client' | 'vendor'

Type of the contact (defaults to Vendor).

Example:vendor
websitestring

The website of the Contact.

Example:https://www.example.com
emailstring

The email of the Contact.

Example:contact@example.com
phone_numberstring

The phone number of the Contact.

Example:+1234567890
updated_fromstring

Start date for filtering Contacts records based on their last update.

Example:2025-01-01

Response

OK

Example response

{
  "data": [
    {
      "id": "123",
      "name": "Google",
      "legal_name": "Google engineering vendor",
      "tax_id": "X1234567",
      "address": {
        "city": "East Ariana",
        "country_code": "SC",
        "line1": "93402 Spencer Points",
        "line2": "Apt. 555",
        "postal_code": "61471",
        "state": "Oklahoma"
      },
      "external_id": "EXT-CONTACT-001",
      "updated_at": "2025-01-01T00:00:00.000Z",
      "iban": "GB25ZFXH46063029945396",
      "bank_code": "BABCESMM",
      "preferred_payment_method": "banktransfer",
      "website": "https://www.example.com",
      "email": "contact@example.com",
      "phone_number": "+1234567890"
    }
  ]
}

Changes