Docs
Data

Data APIs

The Data APIs allow you to work with the core data within your DealCloud site, enabling you to create, retrieve, update, and delete records across various objects (or entryLists) such as deals, contacts, companies, etc. These APIs are essential for integrating with external systems, automating workflows, and building applications that interact with your site's structured data.

Cells

The Cells APIs provides a columnar view of your data, presenting it as key-value pairs. Each cell represents a single value, making this API highly performant for retrieving or updating specific fields.

Rows

The Rows API presents data as complete records, similar to rows in a SQL database. This is useful when you need to work with full objects or retrieve multiple fields at once.

Additional Features of Cells and Rows API

Time Zone Handling

Time Zone Support is controlled by an API parameter: dateTimeBehavior.

  • By default, all date-time values are returned in UTC.
  • To return date-times in the user's local time zone, add the dateTimeBehavior=1 query parameter to your request. The default value is 0 (UTC).
  • When writing data:
    • If the date-time string ends with a "Z", it is treated as UTC.
    • If there is no "Z", the API applies the user's local time zone.

User Proxying with As-User Header

  • Add the As-User header with the proxy user's ID to perform requests on behalf of the principal user.
  • Only user IDs are supported as values.

See more on the guide: making requests on behalf of users

Important Notes:

  1. You can only proxy requests to users for whom you have been granted proxy access.
  2. You must know the unique user ID of the principal user.
  3. When not authorized, a 401 Unauthorized error will be returned.
  4. Proxying as a principal user will reflect the principal (As-User's) data access permissions.
GET {baseUrl}/api/rest/v4/data/entrydata/rows/{{entryTypeId}}
Authorization: Bearer {{token}}
AS-USER: 6045
UsersCells