INinteractly
Edges

Get Edges

Changed on

Endpoint to retrieve all edges. If version_number is not provided but workflow_id is, defaults to the workflow's active_version_number.

get/workflows/v1/edges

Request

  • Base URL
    https://api-qa.interactly.ai
  • URL
    https://api-qa.interactly.ai/workflows/v1/edges
  • Auth
    HTTP bearer

Query parameters

logical_idstring nullable

Filter by logical ID

workflow_idstring
type'direct' | 'conditional' | 'companion'
version_numberinteger nullable

Filter by version number. Returns snapshot edges for that version.

{
  "workflow_id": "5eb7cf5a86d9755df3a6c593"
}
sizeinteger

Number of items per page

pageinteger

Page number

searchstring nullable

Search keywords

startstring date-time nullable

Filter by start time (ISO 8601 format)

endstring date-time nullable

Filter by end time (ISO 8601 format)

Response

Successful Response

totalinteger nullable

Total number of edges available without pagination.

Example response

{
  "edges": [
    {
      "_id": "5eb7cf5a86d9755df3a6c593"
    }
  ]
}

Changes

  • 313ea3ccd136Revision changes
    • info

      added the optional property /////// to the response with the status

  • 0f7ea547091dRevision changes
    • info

      the response's property default value was added for the status