Deals

List Deals

Lists all deals.

GET

/crm/deals

List Deals

curl --request GET \
  --url 'https://api.operating.app/v1/crm/deals?after=%3Cstring%3E&limit=123&createdBefore=%3Cstring%3E&createdSince=%3Cstring%3E&updatedBefore=%3Cstring%3E&updatedSince=%3Cstring%3E&externalId=%3Cstring%3E&projectId=%3Cstring%3E' \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "closeDate": "<string>",
      "createdAt": "<string>",
      "currency": "<string>",
      "description": "<string>",
      "externalId": "<string>",
      "externalSystemName": "<string>",
      "externalUrl": "<string>",
      "id": "<string>",
      "name": "<string>",
      "pipelineId": "<string>",
      "pipelineStageId": "<string>",
      "probability": 123,
      "projectId": "<string>",
      "updatedAt": "<string>",
      "value": 123
    }
  ],
  "meta": {
    "nextCursor": "<string>"
  }
}

Deals represent the sales opportunities of the company. They are linked to projects for staffing purposes.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

afterstringquery

For pagination. Return results after this cursor.

limitnumberquery

For pagination. Return at most this number of results.

createdBeforestringquery

Filter records by whether they were created before a certain instant in ISO8601 format in UTC.

createdSincestringquery

Filter records by whether they were created after a certain instant in ISO8601 format in UTC.

updatedBeforestringquery

Filter records by whether they were updated before a certain instant in ISO8601 format in UTC.

updatedSincestringquery

Filter records by whether they were updated after a certain instant in ISO8601 format in UTC.

externalIdstringquery

Only return deals with the given external id.

projectIdstringquery

Only return deals for the given project.

Response

Successful response

dataobject[]required

Show child attributes

metaobjectrequired

Show child attributes

Still need help? Ask the team