Retrieve Accounts when you need Odie customer records in reporting, analytics, or another connected system. You can list Accounts, retrieve one Account by ID, and use property definitions to interpret custom values.
Use the Accounts endpoints
| Task | Endpoint |
|---|---|
| List Accounts | GET /v1/accounts |
| Retrieve one Account | GET /v1/accounts/{account_id} |
| List property definitions | GET /v1/property-definitions |
List Accounts
curl "https://public-api.us.unison.totango.com/v1/accounts?page[limit]=25" \ --header "Authorization: Bearer <public_api_credential>"
The default page size is 25 Accounts and the maximum is 100. Use page[cursor] to request the next page.
Retrieve one Account
curl "https://public-api.us.unison.totango.com/v1/accounts/<account_id>" \ --header "Authorization: Bearer <public_api_credential>"
Understand Account fields
| Field | Description |
|---|---|
id |
The Odie Account ID. |
display_name |
The Account name shown in Odie. |
external_ids |
Identifiers supplied by connected source systems. |
account_type |
The Account type. |
status |
The current Account status. |
created_at |
When the Account was created. |
updated_at |
When the Account was last updated. |
revenue |
The revenue value stored for the Account. |
renewal_date |
The Account renewal date. |
churn_date |
The Account churn date, when present. |
properties |
Additional Account properties, keyed by property definition. |
Interpret Account properties
Use GET /v1/property-definitions to retrieve the key, label, data type, display format, access mode, options, and other metadata for available properties. Match each definition to the keys returned in an Account's properties object.
FAQs
Which ID should I use to retrieve one Account?
Use the Odie id returned by the list endpoint. Source system identifiers are returned separately in external_ids.