Contacts

Xero Contacts API

Sync contacts data with Xero through Apideck's unified API. One integration, instant access.

In Apideck, this resource is called Customers (API: customers)

Supported Operations for Xero Contacts

Full CRUD support available through our unified API

list

get

create

update

delete

Supported Fields

14 fields

Fields available for Xero Contacts

iddisplay_namecompany_namefirst_namelast_nameaddressesphone_numbersemailswebsitesbank_accountstax_numbercurrencystatusupdated_at

API Model Preview

Sample response structure for contacts

{
  "id": "12345",
  "display_name": "Example Display Name",
  "company_name": "Example Company Name",
  "first_name": "Example First Name",
  "last_name": "Example Last Name",
  "addresses": [
    {
      "id": "123",
      "type": "primary",
      "string": "25 Spring Street, Blackburn, VIC 3130",
      "name": "HQ US",
      "line1": "25 Spring Street",
      "line2": "Suite 100",
      "city": "Blackburn",
      "state": "VIC",
      "postal_code": "3130",
      "country": "US"
    }
  ],
  
  ...

Quick Start Example

Start syncing Xero contacts in minutes

Node.js

import { Apideck } from '@apideck/unify'

const apideck = new Apideck({
  apiKey: process.env.APIDECK_API_KEY,
  appId: 'YOUR_APP_ID',
  consumerId: 'YOUR_CONSUMER_ID'
})

// List contacts from Xero
const result = await apideck.accounting.customers.list({
  serviceId: 'xero'
})

for await (const page of result) {
  console.log(page)
}
// Returns unified contacts data

View full SDK documentation

Popular Use Cases

How Contacts is Commonly Used

Discover the most popular ways businesses integrate Xero contacts data

Accounts Receivable

Push invoices, payment statuses & credits into users' ledgers.

Learn more

Explore all use cases

Other connectors with Contacts support

We build and maintain connectors, so you don't have to. View our full list of Accounting connectors.
Missing a connector? We're able to add new connectors.