Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-07-131453851.1 MB
Customers

List Customers

List Customers

get/accounting/customers

Query parameters

rawboolean

Include raw response. Mostly used for debugging purposes

cursorstring nullable

Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.

limitinteger

Number of results to return. Minimum 1, Maximum 200, Default 20

company_namestring

Company Name of customer to search for

display_namestring

Display Name of customer to search for

first_namestring

First name of customer to search for

last_namestring

Last name of customer to search for

emailstring

Email of customer to search for

status'active' | 'inactive' | 'archived' | 'all' nullable

Status of customer to filter on

updated_sincestring date-time
supplier_idstring

Supplier ID of customer to search for

subsidiary_idstring

Filter by the subsidiary (legal entity) the customer's primary subsidiary belongs to. Only honored on connectors that support multi-entity scoping (e.g. NetSuite OneWorld); ignored elsewhere.

Apply filters

{
  "company_name": "SpaceX",
  "display_name": "Elon Musk",
  "first_name": "Elon",
  "last_name": "Musk",
  "email": "elon@musk.com",
  "status": "active",
  "updated_since": "2020-09-30T07:43:32.000Z",
  "supplier_id": "123"
}
by'created_at' | 'updated_at'

The field on which to sort the Customers

direction'asc' | 'desc'

The direction in which to sort the results

Apply sorting

{
  "by": "updated_at",
  "direction": "desc"
}
example_downstream_propertystring

All passthrough query parameters are passed along to the connector as is (?pass_through[search]=leads becomes ?search=leads)

Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads

{
  "search": "San Francisco"
}
fieldsstring nullable

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: fields=name,email,addresses.city<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

Headers

x-apideck-consumer-idstring required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

x-apideck-company-idstring

The ID of the company to scope requests to. For connectors that support multi-company, this overrides the default company configured in connection settings.

Response

Customers

status_codeinteger required

HTTP Response Status Code

statusstring required

HTTP Response Status

servicestring required

Apideck ID of service provider

resourcestring required

Unified API resource name

operationstring required

Operation performed

_rawRaw nullable

Raw response from the integration when raw=true query param is provided

Example response

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "customers",
  "operation": "all",
  "data": [
    {
      "id": "12345",
      "downstream_id": "12345",
      "display_id": "EMP00101",
      "display_name": "Windsurf Shop",
      "company_name": "SpaceX",
      "company_id": "12345",
      "customer_category": "Insurance",
      "title": "CEO",
      "first_name": "Elon",
      "middle_name": "D.",
      "last_name": "Musk",
      "suffix": "Jr.",
      "individual": true,
      "addresses": [
        {
          "id": "123",
          "type": "primary",
          "string": "25 Spring Street, Blackburn, VIC 3130",
          "name": "HQ US",
          "line1": "Main street",
          "line2": "apt #",
          "line3": "Suite #",
          "line4": "delivery instructions",
          "line5": "Attention: Finance Dept",
          "street_number": "25",
          "city": "San Francisco",
          "state": "CA",
          "postal_code": "94104",
          "country": "US",
          "latitude": "40.759211",
          "longitude": "-73.984638",
          "county": "Santa Clara",
          "contact_name": "Elon Musk",
          "salutation": "Mr",
          "phone_number": "111-111-1111",
          "fax": "122-111-1111",
          "email": "elon@musk.com",
          "website": "https://elonmusk.com",
          "notes": "Address notes or delivery instructions.",
          "row_version": "1-12345"
        }
      ],
      "phone_numbers": [
        {
          "id": "12345",
          "country_code": "1",
          "area_code": "323",
          "number": "111-111-1111",
          "extension": "105",
          "type": "primary"
        }
      ],
      "emails": [
        {
          "id": "123",
          "email": "elon@musk.com",
          "type": "primary"
        }
      ],
      "websites": [
        {
          "id": "12345",
          "url": "http://example.com",
          "type": "primary"
        }
      ],
      "bank_accounts": [
        {
          "bank_name": "Chase Bank",
          "account_number": "123465",
          "account_name": "Main Operating Account",
          "account_type": "credit_card",
          "iban": "GB33BUKB20201555555555",
          "bic": "CHASUS33",
          "routing_number": "021000021",
          "bsb_number": "062-001",
          "branch_identifier": "001",
          "bank_code": "BNH",
          "currency": "USD",
          "country": "US"
        }
      ],
      "notes": "Some notes about this customer",
      "tax_rate": {
        "id": "123456",
        "code": "N-T",
        "name": "GST on Purchases",
        "rate": 10
      },
      "tax_number": "US123945459",
      "taxable": true,
      "currency": "USD",
      "account": {
        "id": "123456",
        "name": "Bank account",
        "nominal_code": "N091",
        "code": "453",
        "parent_id": "123456",
        "display_id": "123456"
      },
      "parent": {
        "id": "12345",
        "name": "Windsurf Shop"
      },
      "status": "active",
      "payment_method": "cash",
      "terms": "Net 30 days",
      "terms_id": "12345",
      "channel": "email",
      "custom_fields": [
        {
          "id": "2389328923893298",
          "name": "employee_level",
          "description": "Employee Level",
          "value": "Uses Salesforce and Marketo"
        }
      ],
      "updated_by": "12345",
      "created_by": "12345",
      "updated_at": "2020-09-30T07:43:32.000Z",
      "created_at": "2020-09-30T07:43:32.000Z",
      "row_version": "1-12345",
      "pass_through": [
        {
          "extend_paths": [
            {
              "path": "$.nested.property",
              "value": {
                "TaxClassificationRef": {
                  "value": "EUC-99990201-V1-00020000"
                }
              }
            }
          ]
        }
      ]
    }
  ],
  "meta": {
    "items_on_page": 50,
    "cursors": {
      "previous": "em9oby1jcm06OnBhZ2U6OjE=",
      "current": "em9oby1jcm06OnBhZ2U6OjI=",
      "next": "em9oby1jcm06OnBhZ2U6OjM="
    },
    "total_count": 1,
    "warnings": [
      {
        "type": "downstream_request_failed",
        "status_code": 429,
        "operation": "getManager"
      }
    ]
  },
  "links": {
    "previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D",
    "current": "https://unify.apideck.com/crm/companies",
    "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"
  }
}