Skip to main content

OData API reference

Endpoint, authentication, entity sets, query options and limits for the read-only Four/Four OData API.

Written by Chris Lloyd

The Four/Four API is a read-only OData v4 service covering conversations, transcript fragments, participants, insights, topics, labels and the CRM records linked to them. BI tools such as Power BI, Excel and Tableau can connect directly, and you can call it from your own code. Your workspace needs an active plan.

Endpoint and authentication

Address

Purpose

Authentication

https://fourfour.ai/odata

Service root

Required

/odata/$metadata

Full schema of tables and fields

None

/odata/openapi.json

OpenAPI description of the service

None

/odata/me

Returns the user and workspace the token belongs to

Required

Send an access token with the api:read scope in the standard Authorization header using the Bearer scheme. For tools that only support Basic authentication, use any user name that suits the tool (the Four/Four tools use your email address) and the token as the password. Create a personal access token or an OAuth client under Settings > Connections; see the API access tokens and OAuth clients article. All requests must use HTTPS.

The automatically generated documentation explains the available entity sets and properties.

Permissions

You see only the data that the token's Four/Four user can see. If conversations are missing compared with the app, check that the token belongs to a user with the same access.

Did this answer your question?