API by router
Onboarding flows
GET
HTTPBearerheader
AuthorizationBearer <token>X-Api-Key?string|nullSuccessful Response
application/json- response
[index: integer]?curl -X GET 'https://example.com/v1/onboarding-flows'Example Response
[ { "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" }]POST
HTTPBearerheader
AuthorizationBearer <token>X-Api-Key?string|nullapplication/json- body
compliance_rules?|nulldescription?string|nullname*NameLength
length <= 200slug*SlugLength
length <= 100stages?array<>Successful Response
application/json- response
compliance_rules*|nullcreated_at*Created AtFormat
date-timedescription*string|nullid*IdFormat
uuidis_active*Is Activename*Nameslug*Slugstages*array<unknown>tenant_id*Tenant IdFormat
uuidupdated_at*Updated AtFormat
date-timecurl -X POST 'https://example.com/v1/onboarding-flows' \ -H 'Content-Type: application/json' \ -d '{ "name": "string", "slug": "string"}'Example Response
{ "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"}GET
HTTPBearerheader
AuthorizationBearer <token>flow_id*Flow IdFormat
uuidX-Api-Key?string|nullSuccessful Response
application/json- response
compliance_rules*|nullcreated_at*Created AtFormat
date-timedescription*string|nullid*IdFormat
uuidis_active*Is Activename*Nameslug*Slugstages*array<unknown>tenant_id*Tenant IdFormat
uuidupdated_at*Updated AtFormat
date-timecurl -X GET 'https://example.com/v1/onboarding-flows/497f6eca-6276-4993-bfeb-53cbbbba6f08'Example Response
{ "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"}DELETE
HTTPBearerheader
AuthorizationBearer <token>flow_id*Flow IdFormat
uuidX-Api-Key?string|nullSuccessful Response
curl -X DELETE 'https://example.com/v1/onboarding-flows/497f6eca-6276-4993-bfeb-53cbbbba6f08'Example Response
Empty
PUT
HTTPBearerheader
AuthorizationBearer <token>flow_id*Flow IdFormat
uuidX-Api-Key?string|nullapplication/json- body
compliance_rules?|nulldescription?string|nullis_active?boolean|nullname?string|nullstages?array<>|nullSuccessful Response
application/json- response
compliance_rules*|nullcreated_at*Created AtFormat
date-timedescription*string|nullid*IdFormat
uuidis_active*Is Activename*Nameslug*Slugstages*array<unknown>tenant_id*Tenant IdFormat
uuidupdated_at*Updated AtFormat
date-timecurl -X PUT 'https://example.com/v1/onboarding-flows/497f6eca-6276-4993-bfeb-53cbbbba6f08' \ -H 'Content-Type: application/json' \ -d '{}'Example Response
{ "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"}