POST /api/v1/query | Customer Data Platform Developer Guide

Syntax

HTTP method: POST
Availability: Customer Data Platform v1.0, Salesforce v51.0
Formats: REST
URI: /api/v1/query

Request Parameters

Field Name	Field Type	Description
limit	int	The numbers of records to be returned. Example: 10
offset	int	Number of rows to skip before starting to return. Example: 100
orderby	string	Comma separated values to sort the result-set in ascending or descending order. Example: GenderId__c ASC,Occupation__c DESC

Examples

Request Header

1Authorization: Bearer {{cdpAuthToken}}

Request

1{
2        "sql": "select BirthDate__c, DataSourceId__c, DataSourceObjectId__c, ExternalRecordId__c, FirstName__c, GenderId__c, Id__c, InternalOrganizationId__c, LastName__c from Individual__dlm where Id__c='100470169'”
3        }

Response

1{
2  "data": [
3    {
4      "Id__c": "100470169",
5      "GenderId__c": "M",
6      "FirstName__c": "Joshua",
7      "LastName__c": "Carrier",
8      "BirthDate__c": "2022-07-12T06:41:47.865044Z",
9      "ExternalRecordId__c": "003f200002a3227163",
10      "DataSourceId__c": "SubscribedUsers",
11      "InternalOrganizationId__c": "",
12      "DataSourceObjectId__c": "Subscribers_for_CDP"
13    }
14  ],
15  "startTime": "2020-12-19T06:50:05.251Z",
16  "endTime": "2020-12-19T06:50:05.251Z",
17  "rowCount": 1,
18  "queryId": "3442db1a-ecef-42b3-b0d8-971ee459efa4",
19  "done": true,
20  "metadata": 
21    {
22    "BirthDate__c": 
23      {
24        "type": "TIMESTAMP WITH TIME ZONE",
25        "placeInOrder": 3,
26        "typeCode": 93
27      },
28    "LastName__c": 
29      {
30        "type": "VARCHAR",
31        "placeInOrder": 2,
32        "typeCode": 12
33      },
34    "FirstName__c": 
35      {
36        "type": "VARCHAR",
37        "placeInOrder": 1,
38        "typeCode": 12
39      },
40    "InternalOrganizationId__c": 
41      {
42        "type": "VARCHAR",
43        "placeInOrder": 5,
44        "typeCode": 12
45      },
46    "Id__c":
47      {
48        "type": "VARCHAR",
49        "placeInOrder": 0,
50        "typeCode": 12
51      },
52    "DataSourceObjectId__c": 
53      {
54        "type": "VARCHAR",
55        "placeInOrder": 6,
56        "typeCode": 12
57      },
58    "DataSourceId__c": 
59      {
60        "type": "VARCHAR",
61        "placeInOrder": 4,
62        "typeCode": 12
63      },
64    "GenderId__c": 
65      {
66        "type": "VARCHAR",
67        "placeInOrder": 7,
68        "typeCode": 12
69      },
70    "ExternalRecordId__c": 
71      {
72        "type": "VARCHAR",
73        "placeInOrder": 8,
74        "typeCode": 12
75      }
76 }
77}

HTTP Responses

Query Services Status Codes