Skip to main content
GET
/
deals
/
{dealId}
Get deal by ID
curl --request GET \
  --url https://api.routera.io/deals/{dealId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "external_id": "<string>",
  "deal_name": "<string>",
  "pipeline": "<string>",
  "deal_stage": "<string>",
  "deal_owner": "jane@example.com",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "archived": true,
  "archived_by": "<string>"
}

​
Endpoint

GET https://api.routera.io/deals/{id}
Route: /deals/{dealId}
Authentication: Bearer JWT Path parameter: dealId — object ID

​
Query parameters

ParameterTypeDefaultDescription
propertiesstring(defaults below)Comma-separated list of additional property names to include alongside the default set for this object type (e.g. ?properties=phone). Names already in the default set are not duplicated. Invalid or disallowed property names return 400.

​
Default response fields

When properties is omitted:
PropertyDescription
idInternal object ID
deal_nameCustom or system field (flat on the object)
pipelineCustom or system field (flat on the object)
deal_stageCustom or system field (flat on the object)
deal_ownerAssigned owner email
external_idExternal identifier (nullable)
archivedfalse when active; ISO timestamp when archived
created_at and updated_at are always included in every response (ISO 8601 UTC), even when not listed above. When an object is archived, archived_by is also included automatically.

​
Response example

200 
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "external_id": "ext-001",
  "created_at": "2026-05-01T10:00:00.000Z",
  "updated_at": "2026-05-28T12:00:00.000Z",
  "archived": false,
  "deal_name": "Enterprise plan",
  "pipeline": "default",
  "deal_stage": "qualified",
  "deal_owner": "jane@example.com"
}

​
Errors

StatusWhen
400Missing dealId in path or invalid properties
401Missing account context
404Object not found

Authorizations

​
Authorization
string
header
required

Bearer JWT with valid account context.

Path Parameters

​
dealId
string
required

Object identifier

Query Parameters

​
properties
string

Comma-separated additional property names to include alongside defaults (e.g. phone). Invalid or disallowed names return 400.

Response

Object

​
id
string
​
external_id
string | null
​
deal_name
string | null
​
pipeline
string | null
​
deal_stage
string | null
​
deal_owner
string | null

Assigned owner email

Example:

"jane@example.com"

​
created_at
string<date-time>
​
updated_at
string<date-time>
​
archived

false when active, or ISO timestamp when archived

​
archived_by
string