Flows

Put records on a pipeline, update flow items and move them between stages.

GET/flows/{flowId}/statesList items in a flow
POST/flows/{flowId}/statesAdd a record to a flow
GET/flows/states/{id}Get a flow item by id
PATCH/flows/states/{id}Update a flow item
DELETE/flows/states/{id}Remove an item from a flow
POST/flows/states/{id}/transitionMove a flow item to another stage
POST/flows/{flowId}/states/bulkBulk-enroll records into a flow
GET/flowsList flows (pipelines)
POST/flowsCreate a flow (pipeline)
GET/flows/{id}Get a flow (pipeline)
PATCH/flows/{id}Update a flow (pipeline / stages)
DELETE/flows/{id}Delete a flow (pipeline)

List items in a flow

GET/flows/{flowId}/states

Scope flows:viewRead-only

Path parameters

Name	Type
`flowId`required	string

Query parameters

Name	Type
`limit`	number
`cursor`	string
`sort`	string
`dir`	"asc" \| "desc"
`filter`	string

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X GET "https://api.klerc.co/api/v1/flows/{flowId}/states?limit=25" \  -H "Authorization: Bearer $KLERC_TOKEN"

Add a record to a flow

POST/flows/{flowId}/states

Scope flows:useWrites data

Path parameters

Name	Type
`flowId`required	string

Request body

Field	Type
`record`	string
`stage`	string
`data`	object

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X POST "https://api.klerc.co/api/v1/flows/{flowId}/states" \  -H "Authorization: Bearer $KLERC_TOKEN" \  -H "Content-Type: application/json" \  -d '{"record":"…","stage":"…","data":{}}'

Get a flow item by id

GET/flows/states/{id}

Scope flows:viewRead-only

Path parameters

Name	Type
`id`required	string

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X GET "https://api.klerc.co/api/v1/flows/states/{id}" \  -H "Authorization: Bearer $KLERC_TOKEN"

Update a flow item

PATCH/flows/states/{id}

Scope flows:useWrites data

Path parameters

Name	Type
`id`required	string

Request body

Field	Type
`data`	object

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X PATCH "https://api.klerc.co/api/v1/flows/states/{id}" \  -H "Authorization: Bearer $KLERC_TOKEN" \  -H "Content-Type: application/json" \  -d '{"data":{}}'

Remove an item from a flow

DELETE/flows/states/{id}

Scope flows:useWrites data

Path parameters

Name	Type
`id`required	string

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X DELETE "https://api.klerc.co/api/v1/flows/states/{id}" \  -H "Authorization: Bearer $KLERC_TOKEN"

Move a flow item to another stage

POST/flows/states/{id}/transition

Scope flows:useWrites data

Path parameters

Name	Type
`id`required	string

Request body

Field	Type
`stage`	string
`toStage`	string

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X POST "https://api.klerc.co/api/v1/flows/states/{id}/transition" \  -H "Authorization: Bearer $KLERC_TOKEN" \  -H "Content-Type: application/json" \  -d '{"stage":"…","toStage":"…"}'

Bulk-enroll records into a flow

POST/flows/{flowId}/states/bulk

Scope flows:useWrites data

Path parameters

Name	Type
`flowId`required	string

Request body

Field	Type
`records`required	array of object

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X POST "https://api.klerc.co/api/v1/flows/{flowId}/states/bulk" \  -H "Authorization: Bearer $KLERC_TOKEN" \  -H "Content-Type: application/json" \  -d '{"records":[{}]}'

List flows (pipelines)

GET/flows

Scope flows:viewRead-only

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X GET "https://api.klerc.co/api/v1/flows" \  -H "Authorization: Bearer $KLERC_TOKEN"

Create a flow (pipeline)

POST/flows

Scope flows:manageWrites data

Request body

Field	Type
`name`required	string
`pluralName`	string
`slug`	string
`object`	string

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X POST "https://api.klerc.co/api/v1/flows" \  -H "Authorization: Bearer $KLERC_TOKEN" \  -H "Content-Type: application/json" \  -d '{"name":"…","pluralName":"…","slug":"…","object":"…"}'

Get a flow (pipeline)

GET/flows/{id}

Scope flows:viewRead-only

Path parameters

Name	Type
`id`required	string

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X GET "https://api.klerc.co/api/v1/flows/{id}" \  -H "Authorization: Bearer $KLERC_TOKEN"

Update a flow (pipeline / stages)

PATCH/flows/{id}

Scope flows:manageWrites data

Path parameters

Name	Type
`id`required	string

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X PATCH "https://api.klerc.co/api/v1/flows/{id}" \  -H "Authorization: Bearer $KLERC_TOKEN"

Delete a flow (pipeline)

DELETE/flows/{id}

Scope flows:manageWrites data

Path parameters

Name	Type
`id`required	string

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X DELETE "https://api.klerc.co/api/v1/flows/{id}" \  -H "Authorization: Bearer $KLERC_TOKEN"