GET
/
accounting
/
contacts
curl --request GET \
  --url https://api.rootfi.dev/v3/accounting/contacts \
  --header 'api_key: <api-key>'
{
  "data": [
    {
      "addresses": [
        {
          "city": "New York",
          "country": "USA",
          "locality": "Main Street",
          "pincode": "123456",
          "platform_id": "CONTACTS_1af68894-ea9f-ee11-be36-7c1e520f50bc_ADDRESS",
          "rootfi_id": 278264,
          "state": "New York",
          "street": "123 Main Street"
        }
      ],
      "contact_name": null,
      "contact_type": "CUSTOMER",
      "currency_id": "00000000-0000-0000-0000-000000000000",
      "external_links": [
        {
          "link": "https://www.google.com",
          "platform_id": "CONTACTS_1af68894-ea9f-ee11-be36-7c1e520f50bc_WEBSITE",
          "rootfi_id": 278264,
          "type": "WEBSITE"
        }
      ],
      "name": "fguvkhg",
      "phone_numbers": [
        {
          "number": "1234567890",
          "platform_id": "CONTACTS_1af68894-ea9f-ee11-be36-7c1e520f50bc_PHONE",
          "rootfi_id": 278264,
          "type": "MOBILE"
        }
      ],
      "platform_id": "f940c3c4-ada3-ee11-a568-6045bd732efb",
      "registration_number": null,
      "rootfi_company_id": 1109,
      "rootfi_created_at": "2024-01-24T11:11:59.779Z",
      "rootfi_id": 238858,
      "rootfi_updated_at": "2024-01-24T11:11:59.000Z",
      "status": null,
      "tax_number": null,
      "updated_at": "2023-12-26T00:00:00.000Z"
    }
  ],
  "next": "eyJyb291ZmlfaWQiOjQ0MDA2MX0=",
  "prev": "eyJyb290ZmlfaWQiOjQ0MDA2MX0=",
  "total_count": 123
}

A contact is an individual or company that buys or sells goods or services from a business. Commonly referred to a customer on a corresponding invoice or a vendor for a bill

Authorizations

api_key
string
headerrequired

Query Parameters

limit
integer | null

The number of objects you want to retrieve

next
string | null

The next page of objects to retrieve

prev
string | null

The previous page of objects to retrieve

expand
string | null

Comma separated fields to expand. Supported values are currency, phone_numbers, addresses, external_links, invoices, bills, invoice_payments, bill_payments, expenses, purchase_orders, sales_orders, bank_transactions

select
string | null

Comma separated fields to select. Supported values are raw_data, data_hash

rootfi_company_id[eq]
integer | null

Filter by rootfi_company_id

return_count
boolean | null

Return the count of the objects

sort[rootfi_created_at]
enum<string>

Sort by rootfi_created_at

Available options:
ASC,
DESC
sort[rootfi_updated_at]
enum<string>

Sort by rootfi_updated_at

Available options:
ASC,
DESC

Response

200 - application/json
next
string | null

The next page of objects to retrieve

prev
string | null

The previous page of objects to retrieve

total_count
integer | null

The total count of the objects

data
object[]
required