List all deals

Retrieve a list of all deals in your workspace. Results are ordered by creation date (newest first).

GET /deals

List all deals

cURL

curl --request GET \
  --url https://{your-subdomain}.neetocrm.com/api/external/v1/deals \
  --header 'X-Api-Key: <x-api-key>'

200

{
  "deals": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "Eve Enterprise Deal",
      "status": "in_progress",
      "value": 10000,
      "currency": "USD",
      "price": "$ 10000",
      "unique_number": "D-001",
      "contact_name": "Eve",
      "contact_id": "c1d2e3f4-a5b6-7890-cdef-123456789012",
      "company_name": "Eve Corp",
      "company_id": "d2e3f4a5-b6c7-8901-def0-234567890123",
      "owner": null,
      "pipeline": null,
      "stage": null,
      "tags": [],
      "created_at": "2025-03-15T10:30:00.000Z",
      "updated_at": "2025-03-15T10:30:00.000Z"
    }
  ],
  "pagination": {
    "total_records": 42,
    "total_pages": 1,
    "current_page_number": 1,
    "page_size": 30
  }
}

Replace {your-subdomain} with your workspace’s subdomain.
Learn how to find your subdomain in Identifying your subdomain.

Headers

X-Api-Key · string · required

X-Api-Key is used to authenticate requests using an API key. Provide your API key in this header to access protected endpoints. Refer to Authentication for more information.

Query Parameters

page_number · integer

Retrieve paginated results by specifying the desired page number. If this parameter is absent, all results will be returned.

page_size · integer

Set the number of results returned in the response. Defaulting to 30 when omitted.

Response

200 - application/json

Successfully retrieved deals.

deals · object[]

List of deals.

Hide child attributes

deals. id · string

Unique identifier for the deal.

deals. name · string

Name of the deal.

deals. status · enum<string>

Current status of the deal.

Available options: in_progress, won, lost

deals. value · number

Monetary value of the deal.

deals. currency · string

Currency code for the deal value.

deals. price · string

Formatted price string (e.g. "$ 10000").

deals. unique_number · string

Auto-generated unique number for the deal.

deals. contact_name · string | null

Name of the associated contact.

deals. contact_id · string | null

Unique identifier of the associated contact.

deals. company_name · string | null

Name of the associated company.

deals. company_id · string | null

Unique identifier of the associated company.

deals. owner · object

Owner of the deal.

Hide child attributes

deals.owner. id · string

Unique identifier of the owner.

deals.owner. name · string

Name of the owner.

deals. pipeline · object

Pipeline the deal belongs to.

Hide child attributes

deals.pipeline. id · string

Unique identifier of the pipeline.

deals.pipeline. name · string

Name of the pipeline.

deals. stage · object

Current stage of the deal within the pipeline.

Hide child attributes

deals.stage. id · string

Unique identifier of the stage.

deals.stage. name · string

Name of the stage.

deals. tags · object[]

Tags associated with the deal.

Hide child attributes

deals.tags. id · string

Unique identifier for the tag.

deals.tags. name · string

Name of the tag.

deals.tags. style · string

Style/color of the tag.

deals. created_at · string<date-time>

Timestamp when the deal was created.

deals. updated_at · string<date-time>

Timestamp when the deal was last updated.

pagination · object

Hide child attributes

pagination. total_records · integer

Total number of records.

pagination. total_pages · integer

Total number of pages available.

pagination. current_page_number · integer

Current page number.

pagination. page_size · integer

Number of records per page.