Workflows
Get Workflow Details
Workflows
Get Workflow Details
Get workflow details by its ID.
GET
/
workflows
/
{workflow_id}
curl --request GET \
--url https://web.inquira.app/api/v1/workflows/{workflow_id} \
--header 'x-api-key: <api-key>'{
"workflow": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"status": "released",
"language": "<string>",
"input_schema": {
"properties": {
"user_first_name": {
"type": "string",
"title": "First Name",
"description": "The patient's first name."
}
}
},
"phone_number_key": "<string>"
}
}Authorizations
API key for authentication
Response
200
application/json
Object with workflow data.
Detailed workflow information
Unique identifier for the workflow
Name of the workflow
When the workflow was created
Status of the workflow
Available options:
released, development Language of the workflow
Schema defining required inputs for the workflow
Field definitions
Definition of a form field
Data type of the field. Possible values:
- string: Text input
- number: Numeric input
- boolean: True/false input
Available options:
string, number, boolean Display title for the field
Detailed description of the field
Special format of the field. Possible values:
- tel: Phone number in E.164 format e.g +31123123123
- date-time: Date and time in ISO 8601 format
- date: Date in ISO 8601 format
- time: Time in 24-hour format e.g 23:59
- email: Email address e.g [email protected]
Available options:
tel, date-time, date, time, email Example:
{
"properties": {
"user_first_name": {
"type": "string",
"title": "First Name",
"description": "The patient's first name."
}
}
}
Key for the phone number input field
curl --request GET \
--url https://web.inquira.app/api/v1/workflows/{workflow_id} \
--header 'x-api-key: <api-key>'{
"workflow": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"status": "released",
"language": "<string>",
"input_schema": {
"properties": {
"user_first_name": {
"type": "string",
"title": "First Name",
"description": "The patient's first name."
}
}
},
"phone_number_key": "<string>"
}
}