Get all stages
GET {{baseUrl}}/stages?pipeline_id=<integer>&sort_by=id&sort_direction=asc&limit=<integer>&cursor=<string>
Returns data about all stages.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
pipeline_id | string | The ID of the pipeline to fetch stages for. If omitted, stages for all pipelines will be fetched. | |
sort_by | string | The field to sort by. Supported fields: id , update_time , add_time , order_nr . | |
sort_direction | string | The sorting direction. Supported values: asc , desc . | |
limit | string | For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed. | |
cursor | string | For pagination, the marker (an opaque string value) representing the first item on the next page |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"success":true,"data":[{"id":1,"order_nr":1,"name":"Stage Name","is_deleted":false,"deal_probability":100,"pipeline_id":1,"is_deal_rot_enabled":true,"days_to_rotten":2,"add_time":"2024-01-01T00:00:00Z","update_time":"2024-01-01T00:00:00Z"}],"additional_data":{"next_cursor":"eyJmaWVsZCI6ImlkIiwiZmllbGRWYWx1ZSI6Nywic29ydERpcmVjdGlvbiI6ImFzYyIsImlkIjo3fQ"}}