Sales Processes

Manage Sales Processes and Sales Process Stages

List Sales Processes

get

List sales processes. Requires the 'sales_processes:read' scope.

Authorizations

ApiKeyAuth

X-API-KeystringRequired

API key for authentication

Query parameters

limitnumber · min: 1 · max: 1000Optional

The number of results to return

Default: 100

offsetnumberOptional

The number of results to skip

Default: 0

Responses

200

Response for status 200

application/json

limitnumberRequired

offsetnumberRequired

totalCountnumberRequired

500

An unknown error occurred, trying again might help.

application/json

get

/v1/sales-processes

HTTPcURLJavaScriptPython

GET /v1/sales-processes HTTP/1.1
Host: api.tryopine.com
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "items": [
    {
      "id": 1,
      "createdAt": "2026-03-03T16:29:18.822Z",
      "updatedAt": "2026-03-03T16:29:18.822Z",
      "name": "text",
      "description": "text",
      "isDefault": true,
      "createdByUserId": 1
    }
  ],
  "limit": 1,
  "offset": 1,
  "totalCount": 1
}

List Sales Process Stages

get

List sales process stages. Requires the 'sales_processes:read' scope.

Authorizations

ApiKeyAuth

X-API-KeystringRequired

API key for authentication

Query parameters

limitnumber · min: 1 · max: 1000Optional

The number of results to return

Default: 100

offsetnumberOptional

The number of results to skip

Default: 0

includeDeletedbooleanOptional

Whether to include deleted sales process stages in the response

Default: false

Responses

200

Response for status 200

application/json

limitnumberRequired

offsetnumberRequired

totalCountnumberRequired

500

An unknown error occurred, trying again might help.

application/json

get

/v1/sales-process-stages

HTTPcURLJavaScriptPython

GET /v1/sales-process-stages HTTP/1.1
Host: api.tryopine.com
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "items": [
    {
      "id": 1,
      "title": "text",
      "category": "PREREQUISITES",
      "deletedAt": "2026-03-03T16:29:18.822Z"
    }
  ],
  "limit": 1,
  "offset": 1,
  "totalCount": 1
}