Deals

Read Deal

Read a deal.

GET

/crm/deals/{id}

Read Deal

curl --request GET \
  --url https://api.operating.app/v1/crm/deals/{id} \
  --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": {}
}

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.

Path Parameters

idstringrequired

Response

Successful response

dataobjectrequired

Show child attributes

metaobjectrequired

Still need help? Ask the team