v1

latestOpenAPI 3.0.1Apache 2.02026-07-1398228598.3 KB
CRM

Execute CRM Query

Executes a query against the connected CRM platform (e.g., Salesforce SOQL). The query is validated for security before execution.

post/crm/query

Request body

querystring required

The query to execute (e.g., SOQL for Salesforce)

Example request

{
  "query": "SELECT Id, Name, Amount FROM Opportunity WHERE StageName = 'Closed Won' LIMIT 10"
}

Response

Query executed successfully

recordsobject[]

Query result records

totalSizeinteger

Total number of records matching the query

doneboolean

Whether all records have been returned

nextRecordsUrlstring

URL to fetch the next batch of records (if paginated)

Example response

{
  "records": [
    {
      "Id": "006ABC123",
      "Name": "Enterprise Deal",
      "Amount": 50000
    }
  ],
  "totalSize": 1,
  "done": true
}