API by router
Onboarding flows
curl -X GET "https://loading/v1/onboarding-flows" \ -H "X-Api-Key: string"[
{
"compliance_rules": {},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"is_active": true,
"name": "string",
"slug": "string",
"stages": [
null
],
"tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
"updated_at": "2019-08-24T14:15:22Z"
}
]{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Create Flow
AuthorizationBearer <token>
In: header
Header Parameters
X-Api-Key?X-Api-Key
compliance_rules?Compliance Rules
description?Description
nameName
Length
length <= 200slugSlug
Length
length <= 100stages?Stages
Response Body
curl -X POST "https://loading/v1/onboarding-flows" \ -H "X-Api-Key: string" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "slug": "string" }'{
"compliance_rules": {},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"is_active": true,
"name": "string",
"slug": "string",
"stages": [
null
],
"tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
"updated_at": "2019-08-24T14:15:22Z"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Get Flow
AuthorizationBearer <token>
In: header
Path Parameters
flow_idFlow Id
Format
uuidHeader Parameters
X-Api-Key?X-Api-Key
Response Body
curl -X GET "https://loading/v1/onboarding-flows/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "X-Api-Key: string"{
"compliance_rules": {},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"is_active": true,
"name": "string",
"slug": "string",
"stages": [
null
],
"tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
"updated_at": "2019-08-24T14:15:22Z"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Delete Flow
AuthorizationBearer <token>
In: header
Path Parameters
flow_idFlow Id
Format
uuidHeader Parameters
X-Api-Key?X-Api-Key
Response Body
curl -X DELETE "https://loading/v1/onboarding-flows/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "X-Api-Key: string"Empty
{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Update Flow
AuthorizationBearer <token>
In: header
Path Parameters
flow_idFlow Id
Format
uuidHeader Parameters
X-Api-Key?X-Api-Key
compliance_rules?Compliance Rules
description?Description
is_active?Is Active
name?Name
stages?Stages
Response Body
curl -X PUT "https://loading/v1/onboarding-flows/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "X-Api-Key: string" \ -H "Content-Type: application/json" \ -d '{}'{
"compliance_rules": {},
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"is_active": true,
"name": "string",
"slug": "string",
"stages": [
null
],
"tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
"updated_at": "2019-08-24T14:15:22Z"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}