List deals linked to company

GET/v1/crm/companies/{companyID}/deals

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Path parameters

companyIDstringrequired

Responses

200OK

itemsDealItem[] | nullrequired

Show properties

Array of DealItem

amount_in_home_currencystringrequired

amount_minorstringrequired

created_atstringrequired

currency_codestringrequired

custom_fieldsanyrequired

display_currencystringrequired

display_currency_minorstringrequired

display_currency_unitinteger<int64>required

expected_close_atstringrequired

home_currency_at_writestringrequired

idstringrequired

metadataanyrequired

minor_unitinteger<int64>required

owner_user_idstring | nullrequired

source_conversation_idstring | nullrequired

stage_idstring | nullrequired

statusstringrequired

titlestringrequired

updated_atstringrequired

metaPaginationMetarequired

Show properties

cursorstring

has_morebooleanrequired

limitinteger<int64>required

next_cursorstring

offsetinteger<int64>

totalinteger<int64>

400Bad Request

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

401Unauthorized

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

403Forbidden

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

404Not Found

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

422Unprocessable Entity

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

500Internal Server Error

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X GET "/v1/crm/companies/string/deals"

const response = await fetch("/v1/crm/companies/string/deals", {
  method: "GET"
});

import requests

response = requests.get(
    "/v1/crm/companies/string/deals",
)

Response

{
  "items": [
    {
      "amount_in_home_currency": "string",
      "amount_minor": "string",
      "created_at": "string",
      "currency_code": "string",
      "custom_fields": "string",
      "display_currency": "string",
      "display_currency_minor": "string",
      "display_currency_unit": 0,
      "expected_close_at": "string",
      "home_currency_at_write": "string",
      "id": "string",
      "metadata": "string",
      "minor_unit": 0,
      "owner_user_id": "string",
      "source_conversation_id": "string",
      "stage_id": "string",
      "status": "string",
      "title": "string",
      "updated_at": "string"
    }
  ],
  "meta": {
    "cursor": "string",
    "has_more": true,
    "limit": 0,
    "next_cursor": "string",
    "offset": 0,
    "total": 0
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}