POST /api/v1/query

Use Query API V1 to query Data Cloud data lake across data model, data lake, unified, and linked objects.

  • HTTP Method: POST
  • Availability: Data Cloud v1.0, Salesforce v51.0
  • format: REST
  • URI: /api/v1/query
ParameterTypeDescription
limitintegerMaximum number of records to return. Default: 49,999. Example: 10
offsetintegerNumber of records to skip before returning results. Example: 100
orderbystringComma-separated values to sort the results in ascending or descending order. Example: GenderId__c ASC, Occupation__c DESC

The request body must contain a JSON object with these fields:

Field NameField TypeDescription
sqlstringThe SQL query to execute. Must be a valid ANSI standard SQL query.

The response includes:

  • data: Array of record objects containing the requested data
  • startTime: ISO 8601 timestamp indicating when the query started executing
  • endTime: ISO 8601 timestamp indicating when the query finished executing
  • rowCount: Number of rows returned by the query
  • queryId: Unique identifier for the query
  • done: boolean indicating if all results have been returned
  • metadata: Object containing metadata about the fields in the result set

The metadata object contains information about each field on the result set:

Field NameField TypeDescription
typestringSQL data type of the field
placeInOrderintegerPosition of the field on the result set
typeCodeintegerNumeric code representing the SQL data type
  • The maximum number of rows returned is 49,999
  • Use the done flag to determine if more results are available
  • When done is false, use the orderby parameter with offset to retrieve the next set of records
  • The API supports ANSI standard SQL queries
  • All queries are executed synchronously
  • The API supports pagination via limit and offset parameters