Skip to main content
GET
Get next steps by profile

Authorizations

x-api-key
string
header
required

API key for authentication. Obtain from your Operate dashboard.

Path Parameters

profileId
string<uuid>
required

The unique identifier (UUID) of the profile

Example:

"550e8400-e29b-41d4-a716-446655440000"

Query Parameters

include_completed
boolean
default:false

Whether to include completed items in the results. Defaults to false (only pending/active items).

Examples:

true

false

limit
number
default:50

Maximum number of next steps to return per page (1-100)

Required range: 1 <= x <= 100
Examples:

10

25

50

Response

200

Successful response