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.

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
pipelineId
string
stageId
string
crmCompanyId
string
contactId
string
ownerId
string
isOpen
boolean
isWon
boolean
isLost
boolean
page
number
limit
number
sortBy
enum<string>
Available options:
name,
value,
expectedCloseDate,
createdAt,
updatedAt
sortOrder
enum<string>
Available options:
ASC,
DESC

Response

deals
object[]
required
total
number
required
page
number
required
limit
number
required
totalPages
number
required