v1

latestOpenAPI 3.0.0Cognigy Proprietary License2026-07-2239524.1 MB
Flows

Get a Flow

Gets a Flow from a Project.

get/v2.0/flows/{flowId}

Path parameters

flowIdstring required

The unique identifier for the Flow.

Query parameters

preferredLocaleIdstring

The unique identifier for the Locale for the response.

Headers

Accept'application/json' | 'application/hal+json' | 'application/xml' | 'text/xml' | 'text/csv'

The Accept header specifies the media type that the client expects in the response. Available options: application/json, application/hal+json, application/xml, text/xml, text/csv. The default value is application/json.

Response

Returns Flow Object

referenceIdstring uuid
intentTrainGroupReferencestring
isTrainingOutOfDateboolean
namestring
descriptionstring
contextobject
attachedFlowsstring[]
attachedLexiconsstring[]
imgstring
_idstring
createdAtinteger

Unix-timestamp

lastChangedinteger

Unix-timestamp

createdBystring
lastChangedBystring

Example response

{
  "createdAt": 1694518620,
  "lastChanged": 1694518620
}