Use the Unison Public API

The Unison Public API gives your team read access to customer and operational data in Unison. Use it to retrieve Accounts, health snapshots, Notes, Workflows, Workflow emails, Work Items, and email suppressions for reporting and connected systems.

The Public API is read only. It does not create, update, or delete records in Unison.

Choose your regional base URL

Region Base URL
United States https://public-api.us.unison.totango.com
Europe https://public-api.unison.totango.com

Authenticate your requests

Send a Unison Public API credential as a bearer token in the Authorization header.

curl "https://public-api.us.unison.totango.com/v1/accounts?page[limit]=25" \
  --header "Authorization: Bearer papi_v1_<key>_<secret>"
Treat the complete credential as a secret. Do not place it in client side code, shared documents, or source control.

Retrieve available resources

Resource Endpoints
Property definitions GET /v1/property-definitions
Accounts GET /v1/accounts
GET /v1/accounts/{account_id}
Account health snapshots GET /v1/account-health-snapshots
Notes GET /v1/notes
GET /v1/notes/{note_id}
Workflows GET /v1/workflows
GET /v1/workflows/{workflow_id}
GET /v1/workflows/{workflow_id}/runs
Workflow emails GET /v1/workflow-emails
GET /v1/workflow-emails/{email_id}
GET /v1/workflows/{workflow_id}/email-templates
Work Items GET /v1/work-items
GET /v1/work-items/{work_item_id}
Email suppressions GET /v1/email-suppressions

Page through list responses

List endpoints return records in items and paging information in page. Pass page[next_cursor] as page[cursor] in the next request. Continue until page[has_more] is false.

{
  "items": [],
  "page": {
    "next_cursor": "opaque-cursor",
    "has_more": true
  }
}

Handle API responses

Status Meaning
200 The request succeeded.
400 or 422 The request or one of its parameters is not valid.
401 The credential is missing or not valid.
403 The credential cannot access the requested resource.
404 The requested record was not found.
429 Too many requests were sent. Retry after a delay.
500 or 503 The service could not complete the request. Retry after a delay.

Review the technical reference

Use the Unison Public API reference for the complete request and response schemas.

FAQs

Can the Public API change data in Unison?

No. The available operations use GET and provide read access only.

Can I load the data into a warehouse such as Snowflake?

Yes. Your team can schedule API requests and load the returned data into your warehouse. The Public API is the data source for that process, not a native warehouse export.

Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request