Data APIs

The Data APIs are designed to work with data in the system. These APIs support full CRUD operations of all data, except for User and Marketing Activities. To get the most out of the data APIs you are expected to understand the site's schema, expecially the schema of the entry types you're working with. A full description the Schema is available in the Schema section of this document.

If you need to work with users (i.e. adding user, removing users, user permissions etc.), check out the User Management APIs. Extra user attributes or custom fields (office location, job titles, etc) are considered data and can be updated using the data API.

There are 2 ways of working with the API:

Cells

These are Key-Value pairs. Each cell is a single value. Cells are the most granular way of working with data. Cells are the fastest way to work with data.

Rows

These are collections of cells. Each row is a single record. Rows are the most common way of working with data. Rows are closer to a standard database table and are the best for working the ETL applications.

Swagger

Data API Swagger

Time Zone Support: Localize Date-Times

Reading Data

By default, date-times in the API are returned in UTC. However, you can localize the date-times in the API response to the API user's local timezone. Use query parameter dateTimeBehaviorand set to 1 to retrieve all date-times in local time-zone. Value of 0 is the default behavior and returns date-times in UTC.

Writing Data

To write data in UTC via the API, use the letter Z at the end of the date-time. To write data in the local time-zone, omit the Z at the end.

User Proxying

All Data endpoints supports user proxying or delegation. When making a data request, if you wish to delegate the action as another user you can add a As-User modifier to the header of the request.

Important

You're only able to delegate requests to users whom you've been granted access to proxy as.
You'll need to know the user's unique identifier.

GET {baseUrl}/api/rest/v4/data/entrydata/rows/{{entryTypeId}} HTTP/1.1
Authorization: {{auth}}
AS-USER: 6045

Limits

Requests to the Data APIs are limited to 5 call per second.

Token Cells