# Get Client Application

# Overview
Use this API to get details of the Client application in the Conversation Manager.
## Scope
Client application must have 'app.conversation.conversationmgr.manage' or 'app.conversation.conversationmgr.read' scope assigned.

Endpoint: GET /clientapplications/{id}
Security: oAuthClient

## Path parameters:

  - `id` (string, required)
    id of object
    Example: "7b6c5fff-036e-4a40-b68a-a67c592fc079"

## Response 200 fields (application/json):

  - `id` (string)

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

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

  - `name` (string, required)
    Unique name for client application

  - `description` (string)

  - `active` (boolean)

  - `roles` (array, required)

  - `roles.name` (string, required)
    Client aplication type
    Enum: "customer", "custom_bot", "egain_bot", "egain_agent", "custom_agent", "business_notification"

  - `roles.version` (string, required)
    Conversation Hub will send payload which is specific to this version.
    Enum: "v1", "v3"

  - `roles.callback` (string, required)
    Callback API to recieve messages from Conversation Hub sent by various participants in conversation. Callback APIs needs to respond within 5 seconds. We strongly recommend to process message asynchronously. API must return 401 if Authorization header is expired, Conversation Hub will generate new Authorization header on 401.
    Example: "https://example.support.com/messaging/callback/customer"

  - `roles.notificationEmail` (string, required)
    If client application callback is not reachable, Conversation Hub sends a notification to this email address
    Example: "admin@example.com"

  - `roles.headers` (array)
    Custom headers for callback, Conversation Hub will include these while sending message to callback

  - `roles.headers.name` (string, required)
    name of attribute

  - `roles.headers.value` (string, required)
    value of attribute

  - `roles.authentication` (object)
    Authentication for callback API.

  - `roles.authentication.id` (string, required)
    UUID generated for client application
    Example: "a987d07a-d59c-11ea-87d0-0242ac13000."

## 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