Skip to main content

Get deal

Read one organization-scoped Deal and its relationship labels.

GET/api/deals/{deal_id}
Scope deals:readUpdated October 23, 2026

This page documents the canonical HTTP contract. Switch to the CLI example when you want the operator workflow.

Returns canonical Deal fields plus compact company, person, pipeline, and stage labels. Archived Deals remain readable by exact ID.

Path parameters

  • deal_idrequired

    string

    Exact Deal ID.

Errors

StatusMeaning
401Authentication required.
403Missing deals:read scope.
404Deal not found in this organization.

Docs