Skip to main content
GET
/
deals
List deals
curl --request GET \
  --url https://api.routera.io/deals \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "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>"
    }
  ],
  "pagination": {
    "limit": 123,
    "offset": 123,
    "count": 123
  }
}

​
Endpoint

GET https://api.routera.io/deals
Route: /deals
Authentication: Bearer JWT

​
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.
archivedbooleanfalseSet to true to include archived objects
limitinteger10Maximum number of results (10–100)
offsetinteger0Pagination offset

​
Default response fields

When properties is omitted, each item in data includes:
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

200 — Paginated list 
{
  "data": [
    {
      "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"
    }
  ],
  "pagination": {
    "limit": 10,
    "offset": 0,
    "count": 1
  }
}

​
Errors

StatusWhen
400Invalid properties query (empty list or invalid property name)
401Missing or invalid account context in JWT
500Internal server error
{ "message": "Invalid property name: example", "error": true }

Authorizations

​
Authorization
string
header
required

Bearer JWT with valid account context.

Query Parameters

​
properties
string

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

​
archived
boolean

Include archived objects when true

​
limit
integer
default:10

Maximum results (default 10, max 100)

Required range: 1 <= x <= 100
​
offset
integer
default:0

Pagination offset (default 0)

Required range: x >= 0

Response

Paginated list

​
data
object[]
​
pagination
object