Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Bearer token: a Platform API Key (format: ak_live::) or a Personal Access Token (format: rgo-...). PATs always act as the token owner.

Path Parameters

id
string
required

Query Parameters

archived
enum<string>
default:false

false returns active deals, true only archived deals, all both. Each deal carries archivedAt (null when active).

Available options:
false,
true,
all

Response

id
string
required
name
string
required
stageId
string
required
archivedAt
string<date-time> | null
required

When the deal was archived; null while it is active.

value
number