Newer Version Available
Query
When a SOQL query is executed, up to 2,000 records can be returned at a time in a synchronous request. If the number of results exceeds this limit, the response contains the first set of 2,000 results, a false value for done, and a query locator. The query locator can be used with the Query More Results resource to retrieve the next set of records.
- URI
- /services/data/vXX.X/query?q=SOQL_query
- Formats
- JSON, XML
- HTTP Method
- GET
- Authentication
- Authorization: Bearer token
- Parameters
- Response body
- The response contains the total number of records returned by the QueryAll request (totalSize), a boolean indicating whether there are no more results (done), the URI of the next set of records (nextRecordsUrl), and an array of query result records (records).
- Example response body
-
1{ 2 "totalSize": 3222, 3 "done": false, 4 "nextRecordsUrl": "/services/data/v56.0/query/01gRO0000016PIAYA2-500", 5 "records": [ 6 { 7 "attributes": { 8 "type": "Contact", 9 "url": "/services/data/v56.0/sobjects/Contact/003RO0000035WQgYAM" 10 }, 11 "Id": "003RO0000035WQgYAM", 12 "Name": "John Smith" 13 }, 14 ... 15 ] 16}
Resources for Executing SOQL Queries
- For an example, see Execute a SOQL Query.
- To change the batch size, see Query Options Header.
- To get feedback on a query and a report using the explain parameter, see Get Feedback on Query Performance
-
For more information on SOQL in general, see the SOQL and SOSL Reference.