Get a deal by id

GET

/v1/deals/{id}

• Production

Returns a single deal with its linked tasks. Requires scope deals:read.

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

integer

Responses

200

Deal found.

A sales pipeline deal. tasks is populated on GET by id, omitted in list responses.

object

id

integer

title

string

contactId

integer

nullable

contactName

string

nullable

value

number

currency

string

stage

string

Allowed values: Lead Qualified Proposal Negotiation Won Lost

probability

0-100.

integer

expectedCloseAt

string format: date-time

nullable

closedAt

string format: date-time

nullable

notes

string

nullable

openTaskCount

integer

createdAt

string format: date-time

updatedAt

string format: date-time

nullable

tasks

Array<object>

nullable

object

id

integer

title

string

status

string

Allowed values: Open InProgress Done

priority

string

Allowed values: Low Medium High

dueAt

string format: date-time

nullable

isOverdue

boolean

401

Missing or invalid bearer token.

Standard error envelope for all v1 error responses.

object

error

Machine-readable error code.

string

Allowed values: bad_request not_found conflict unauthorized forbidden rate_limited internal_error

message

Human-readable explanation of the error.

string

details

Optional structured context (field-level validation errors, etc.).

nullable

Example

{
  "error": "unauthorized",
  "message": "Invalid bearer principal"
}

403

The API key does not have the required scope for this operation.

Standard error envelope for all v1 error responses.

object

error

Machine-readable error code.

string

Allowed values: bad_request not_found conflict unauthorized forbidden rate_limited internal_error

message

Human-readable explanation of the error.

string

details

Optional structured context (field-level validation errors, etc.).

nullable

Example

{
  "error": "forbidden",
  "message": "scope contacts:write is required"
}

404

The requested resource does not exist or is not owned by the caller.

Standard error envelope for all v1 error responses.

object

error

Machine-readable error code.

string

Allowed values: bad_request not_found conflict unauthorized forbidden rate_limited internal_error

message

Human-readable explanation of the error.

string

details

Optional structured context (field-level validation errors, etc.).

nullable

Example

{
  "error": "not_found",
  "message": "contact not found"
}