Login

This API creates an asynchronous search in GRAX to stream record data or download in CSV+ZIP form. Below is the payload in the body you post into the API.

Object: Salesforce Object API Name
Status Values: all | live | deleted | archived | archivedDeleted
TimeField: createdAt | deletedAt | modifiedAt
Filters Array of filters

A filter is:

Field Salesforce Object Field API name
Filter Type eq | contains
Value Value to filter by

Sample Body Payload

{
  "object": "Case",
  "timeField": "deletedAt",
  "timeFieldMin": "2022-11-01T04:00:00Z",
  "timeFieldMax": "2022-11-09T05:00:00Z",
  "status": "archivedDeleted",
  "filters": [
    {
      "field": "CaseNumber",
      "filterType": "eq",
      "value": "12345"
    }
  ]
}

Utilize the Location returned in the header to query the status.

Sample Response

Language
Authorization
http
URL