Sign in

v1

latestOpenAPI 3.1.02026-08-04103211436.0 KB
Contacts

List contacts

Returns the contacts (clients/suppliers) of a company. Results are paginated: use limit to control page size and pass the returned nextPageToken to fetch the next page.

get/contacts/{companyId}

Path parameters

companyIdstring required

Query parameters

limitinteger

Maximum number of objects to return in the response. Default 500, maximum 2000.

Maximum number of objects to return in the response. Default 500, maximum 2000.

nextPageTokenstring

Token to fetch the next page of results, taken from the nextPageToken returned by the previous request with the same filters. Omit it to fetch the first page. An invalid or malformed token is rejected with 404.

Token to fetch the next page of results, taken from the nextPageToken returned by the previous request with the same filters. Omit it to fetch the first page. An invalid or malformed token is rejected with 404.

Response

Successful Response

nextPageTokenstring nullable

Token to fetch the next page of results. null when there are no more pages.

Example response

{
  "data": [
    {
      "tradeName": "Acme Supplies",
      "legalName": "Acme Supplies S.L.",
      "taxId": "B12345678",
      "contact": {
        "phone": "+34600000000",
        "email": "billing@acme-supplies.com",
        "name": "John",
        "surname": "Doe"
      },
      "address": {
        "postalCode": "28001",
        "address": "Calle Mayor 10, 3B",
        "province": "Madrid",
        "city": "Madrid",
        "country": "Spain"
      },
      "accounts": [
        {
          "swift": "BBVAESMMXXX",
          "iban": "ES9121000418450200051332"
        }
      ],
      "paymentsAccounts": [
        {
          "details": {
            "iban": "ES9121000418450200051332",
            "bic": "BBVAESMMXXX",
            "swift": "BBVAESMMXXX",
            "accountNumber": "123456789",
            "routingNumber": "021000021",
            "sortCode": "040004",
            "institutionNumber": "001",
            "transitNumber": "12345",
            "bsb": "062-000"
          }
        }
      ],
      "accountingCode": "4300001",
      "paymentMethod": "bank-transaction",
      "paymentTerms": 30,
      "attributes": [
        {
          "customId": "cost-center",
          "value": "Marketing",
          "valueCustomId": "marketing"
        }
      ],
      "customId": "erp-contact-001"
    }
  ]
}