# Get Orchestrations

# Overview
Use this API to Get all conversation orchestration details.
## Scope
Client application must have 'app.conversation.conversationmgr.manage' or 'app.conversation.conversationmgr.read' scope assigned.

Endpoint: GET /orchestrations
Security: oAuthClient

## Response 200 fields (application/json):

  - `paginationInfo` (object)

  - `paginationInfo.count` (integer)
    Total number of records that match criteria of API call

  - `paginationInfo.pagenum` (integer)
    Page number

  - `paginationInfo.pagesize` (integer)
    Number of results per page

  - `orchestration` (array)
    Example: [{"id":"45a095f4-d0ee-4220-a689-22b541c58f67","name":"default_orchestration","description":"Created for Custom channel.","active":true,"created":"2021-03-21T14:29:01.516Z","modified":"2021-03-28T14:29:01.516Z","applications":{"botConfiguration":{"forwardTranscript":true,"bots":[{"id":"a09dddd6-394b-4039-86bc-a5dd89ee5e8d","participant":{"id":"b09dddd6-394b-4039-86bc-a5dd89ee5e8d"},"onEscalation":{"agent":{"id":"c09dddd6-394b-4039-86bc-a5dd89ee5e8d"}}}]},"customerConfiguration":{"customer":{"id":"b09dddd6-394b-4039-86bc-a5dd89ee5e8d"}}}},{"id":"b5fc053c-77f4-4445-b6df-2e744aef8f4f","name":"default_orchestration_2","description":"Created for Custom channel","active":true,"created":"2021-03-21T14:29:01.516Z","modified":"2021-03-28T14:29:01.516Z","applications":{"customerConfiguration":{"customer":{"id":"b09dddd6-394b-4039-86bc-a5dd89ee5e8d"}},"agentConfiguration":{"agents":[{"id":"c09dddd6-394b-4039-86bc-a5dd89ee5e8d"}]}}}]

  - `orchestration.id` (string)

  - `orchestration.created` (string)
    Last modified time in GMT

  - `orchestration.modified` (string)
    Last modified time in GMT

  - `orchestration.name` (string)
    Name for orchestration
    Example: "default_orhchestration"

  - `orchestration.description` (string)

  - `orchestration.active` (boolean)

  - `orchestration.applications` (object)

  - `orchestration.applications.botConfiguration` (object)
    Required if agentConfiguration is not provided

  - `orchestration.applications.botConfiguration.forwardTranscript` (boolean)
    If VA session is not escalated and customer is identifiable then forward transcript to eGain agent

  - `orchestration.applications.botConfiguration.bypassVaDuration` (number)
    If customer returns before this duration(in minutes) ends then bypass va and escalate to agent directly.

  - `orchestration.applications.botConfiguration.bots` (array, required)

  - `orchestration.applications.botConfiguration.bots.id` (string, required)
    UUID generated by Conversation Hub for bot client application.

  - `orchestration.applications.botConfiguration.bots.participant` (object, required)

  - `orchestration.applications.botConfiguration.bots.participant.id` (string, required)
    UUID generated by Conversation Hub for bot participant.

  - `orchestration.applications.botConfiguration.bots.onEscalation` (object)

  - `orchestration.applications.botConfiguration.bots.onEscalation.agent` (object, required)

  - `orchestration.applications.botConfiguration.bots.onEscalation.agent.id` (string, required)
    UUID generated by Conversation Hub for agent client application, on escalation from bot, message will be sent to this client application

  - `orchestration.applications.customerConfiguration` (object)
    details of customer client app, this object must be specified for custom channels.

  - `orchestration.applications.customerConfiguration.customer` (object, required)
    Replies sent by bot or agent will be sent to this client application

  - `orchestration.applications.customerConfiguration.customer.id` (string, required)
    UUID generated by Conversation Hub for customer client application

  - `orchestration.applications.agentConfiguration` (object)
    Details of agent client app. Required if botConfiguration is not provided.

  - `orchestration.applications.agentConfiguration.agents` (array, required)

  - `orchestration.applications.agentConfiguration.agents.id` (string, required)
    UUID generated by Conversation Hub for agent application

## Response 400 fields (application/json):

  - `code` (string, required)
    String that follow the pattern {integer}-{integer}. 
  * The first part is http status code.  The code is unique as a whole. Nothing common between 400-101 and 404-101

  - `developerMessage` (string, required)
    Response explaining what happened

  - `details` (array)

  - `details.key` (string, required)

  - `details.value` (string)

  - `userMessage` (string)
    UI friendly message only supported by some API.  
  * Client must request explicitly by passing X-egain-error-message=yes header

## Response 401 fields (application/json):

  - `code` (string, required)
    String that follow the pattern {integer}-{integer}. 
  * The first part is http status code.  The code is unique as a whole. Nothing common between 400-101 and 404-101

  - `developerMessage` (string, required)
    Response explaining what happened

  - `details` (array)

  - `details.key` (string, required)

  - `details.value` (string)

  - `userMessage` (string)
    UI friendly message only supported by some API.  
  * Client must request explicitly by passing X-egain-error-message=yes header

## Response 403 fields (application/json):

  - `code` (string, required)
    String that follow the pattern {integer}-{integer}. 
  * The first part is http status code.  The code is unique as a whole. Nothing common between 400-101 and 404-101

  - `developerMessage` (string, required)
    Response explaining what happened

  - `details` (array)

  - `details.key` (string, required)

  - `details.value` (string)

  - `userMessage` (string)
    UI friendly message only supported by some API.  
  * Client must request explicitly by passing X-egain-error-message=yes header

## Response 500 fields (application/json):

  - `code` (string, required)
    String that follow the pattern {integer}-{integer}. 
  * The first part is http status code.  The code is unique as a whole. Nothing common between 400-101 and 404-101

  - `developerMessage` (string, required)
    Response explaining what happened

  - `details` (array)

  - `details.key` (string, required)

  - `details.value` (string)

  - `userMessage` (string)
    UI friendly message only supported by some API.  
  * Client must request explicitly by passing X-egain-error-message=yes header