Workflow info API

Warning

This page may be subject to changes!

This endpoint provides a way to fetch simple information about a workflow (name / desc / type etc.)

Endpoint¶

GET https://api.giosg.com/api/reporting/workflow/v1/orgs/<organization_id>/workflows/<workflow_id>/info/

URL attributes¶

Attribute	Type	Required	Description
`organization_id`	String (UUID)	Required	ID of the organization for which the data is requested
`workflow_id`	String (UUID)	Required	ID of the workflow for which the data is requested

Response¶

The response will be a object like:

Attribute	Type	Description
`id`	uuid	A unique string for workflow
`org_id`	uuid	The unique UUID for your company
`type`	string	Tells the internal "type" of the workflow (`giosg-default` / `interaction` / `user-generated`)
`name`	string	The name of this workflow
`description`	string	The description of this workflow
`modified_at`	timestamp	Timestamp of workflow last modified time in ISO format
`is_published`	boolean	Boolean value if workflow is published or still draft
`start_date`	string	Date string of the first event
`end_date`	string	Date string of the last event

Example success response in JSON format:

{
    "id": "fef456f5-fbde-42d1-be16-797b6d621193",
    "org_id": "38d0571c-3693-4893-a888-6726d9e6f0e8",
    "type": "giosg-default",
    "name": "Workflow name",
    "description": "Test workflow",
    "modified_at": "2023-01-01T12:00:00.000Z",
    "is_published": true,
    "start_date": "2018-01-01T00:00:00Z",
    "end_date": "2023-01-14T00:00:00Z",
}

Response HTTP status codes¶

Warning

This section should be fact-checked before going live!

Endpoint returns the following HTTP status codes:

200 if the request was successful
401 if you are not authenticated
403 if you do not have active subscription
403 if you do not have access to the organization
403 if you do not have reporting permission
404 if data was not found
406 if filtering with something that is not yet implemented
500 if an unexpected error occurred with the query