List contacts

Pull your customer list into whatever you're building. This is the call a connector runs first, and then again on a schedule to pick up what changed.

get /api/public/v1/contacts

Headers

Header	Value	Why
X-AUTH-TOKEN	obl_live_...	Your API key. Every call needs one.

Parameters

Name	In	What it does
_page	query	Rarely needed. Follow the Link header instead, which knows where the next page starts. Defaults to 1.
updatedSince	query	Only contacts touched at or after this moment. Store the newest updatedAt you saw and send it back next time.

The call

Request

curl https://app.obraledger.com/api/public/v1/contacts \
  -H "X-AUTH-TOKEN: obl_live_..."

Want to fill this in and run it? Open it in the playground.

What comes back

An array of contacts, with a Link header pointing at the next page. There's no total count - see how paging works.

Shape of the response

Generated from the contract, so it is every field and nothing invented. The values are type names rather than a specimen record - we won't put made-up data on a page.

[
  {
    "id": "string",
    "createdAt": "string",
    "updatedAt": "string",
    "firstName": "string",
    "middleName": "string",
    "lastName": "string",
    "nickName": "string",
    "salutation": "string",
    "title": "string",
    "jobTitle": "string",
    "department": "string",
    "email": "string",
    "phoneOffice": "string",
    "phoneMobile": "string",
    "phoneHome": "string",
    "phoneOther": "string",
    "fax": "string",
    "assistantName": "string",
    "assistantPhone": "string",
    "description": "string",
    "birthDate": "string",
    "gender": "string",
    "companyId": "string",
    "isCustomer": false,
    "isSupplier": false,
    "isPrimary": false,
    "doNotCall": false,
    "lifecycleStage": "string",
    "leadSource": "string",
    "reportsToId": "string",
    "tags": []
  }
]

When it fails

Match on the type in the body, not on the status. A 403 covers both "this key can't do that" and "this record won't allow it", and the number alone can't tell you which.

401 Authentication failed — the `X-AUTH-TOKEN` header is missing, malformed, revoked, or belongs to a different company. Not retryable: the same token will fail identically.

unauthenticated
403 Authenticated, but not allowed to do this.

forbidden scope_required
429 Rate limit exceeded for this API key. `Retry-After` says how many seconds to wait; `X-RateLimit-Limit` and `X-RateLimit-Remaining` report the budget on every response, not just this one.

rate_limited

The rest of contacts

Base URL https://app.obraledger.com. This page is generated from the contract the product publishes.

Building something and stuck? Tell us - we'd rather hear it than have you guess.