Skip to content
Optiwork API Docs

Overview

Read access to a user's address book in the Optiwork suite.

Optiwork Contacts API v2026.09.25.1131

Section titled “Optiwork Contacts API v2026.09.25.1131”

The Optiwork Contacts API gives read access to the address book of the authenticated user: the people and organizations they keep, with their e-mail addresses, phone numbers and employers. It offers three ways in — a plain listing, a ranked search, and a lightweight autocomplete meant for “To:” fields and pickers.

Base URL

All endpoints are served under the fixed Contacts host: https://contacts.work.optidata.cloud/api.

Authentication

Every endpoint requires a Bearer JWT passport. Your personal passport is available in Optiwork at https://work.optidata.cloud/user/settings/security (My account > Profile > Security), where it is shown as the authentication key. Send it on every request:

Authorization: Bearer opk_xxxxxxxxxxxxxxxxxxxxxxxx
Accept: application/json

A request without a key returns 401. A key that is expired or not recognised returns 419; get a fresh authentication key from the same settings page and retry.

Conventions

  • Every endpoint answers only with the caller’s own contacts — the entries in their personal address book. Contacts in the trash are never returned.
  • A contact has a type: person and organization are the everyday ones. A person’s employers are listed in companies, each itself an organization contact.
  • E-mail addresses and phone numbers are contact methods. A contact can hold several of each; the one flagged is_primary sorts first.
  • Array query parameters use the bracketed form, e.g. filters[id][]=101&filters[id][]=102.
  • Timestamps are ISO-8601 in UTC (e.g. 2026-10-15T20:31:01.000000Z).
  • Validation failures return 422 with a per-field errors map. Messages are written in the caller’s language.

Operations

Section titled “ Operations ”
GET
/contacts
GET
/contacts/search
GET
/contacts/autocomplete

Authentication

Section titled “ Authentication ”

bearerAuth

Section titled “bearerAuth”

The authentication key (JWT passport) from My account > Profile > Security at work.optidata.cloud/user/settings/security.

Security scheme type: http

Bearer format: JWT