Run a SOQL query

v1.0.0

Executes a SOQL query via the REST query endpoint and returns the matching records. Follow nextRecordsUrl with further requests when done is false.

Required scopes: api.

Input

{
  "type": "object",
  "properties": {
    "q": {
      "type": "string",
      "description": "The SOQL query to execute, e.g. `SELECT Id, Name FROM Account LIMIT 10`."
    }
  },
  "required": [
    "q"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "required": [
    "totalSize",
    "done",
    "records"
  ],
  "properties": {
    "totalSize": {
      "type": "number",
      "description": "Total number of records matching the query."
    },
    "done": {
      "type": "boolean",
      "description": "True when this response contains the full result set."
    },
    "nextRecordsUrl": {
      "type": "string",
      "description": "Path to the next batch of records when `done` is false."
    },
    "records": {
      "type": "array",
      "description": "The matching records, each with an `attributes` object and the selected fields.",
      "items": {
        "type": "object"
      }
    }
  }
}