# index

Endpoint: GET /api/chat_interfaces
Version: 1.0.0
Security: ApiKeyAuth

## Query parameters:

  - `filter[name]` (string)
    Example: "00000000-0000-0000-0000-000000000001"

  - `filter[project_id]` (string)
    Example: "00000000-0000-0000-0000-000000000001"

  - `include` (string)
    Example: "createdBy,updatedBy"

  - `sort` (string)
    Example: "id"

## Response 200 fields (application/vnd.api+json):

  - `data` (array, required)

  - `data.id` (string, required)

  - `data.type` (string, required)

  - `data.links` (object, required)

  - `data.links.self` (string, required)

  - `data.attributes` (object, required)

  - `data.attributes.createdAt` (string, required)

  - `data.attributes.updatedAt` (string, required)

  - `data.attributes.projectId` (string, required)

  - `data.attributes.name` (string, required)

  - `data.attributes.starterMessage` (string, required)

  - `data.attributes.textInputEnabled` (boolean, required)

  - `data.attributes.textInputAgentId` (string,null, required)

  - `data.attributes.isManaged` (boolean, required)

  - `data.attributes.chatInterfaceButtons` (array, required)

  - `data.relationships` (object)

  - `data.relationships.createdBy` (object, required)

  - `data.relationships.createdBy.data` (object, required)

  - `data.relationships.createdBy.data.type` (string, required)

  - `data.relationships.createdBy.data.id` (string, required)

  - `data.relationships.updatedBy` (object, required)

  - `data.relationships.updatedBy.data` (object, required)

  - `data.relationships.updatedBy.data.type` (string, required)

  - `data.relationships.updatedBy.data.id` (string, required)

  - `meta` (object, required)

  - `meta.total` (integer, required)

  - `links` (object, required)

  - `links.first` (string, required)

  - `links.last` (string, required)

  - `included` (array)

  - `included.id` (string, required)

  - `included.type` (string, required)

  - `included.attributes` (object, required)

  - `included.attributes.name` (string, required)

  - `included.attributes.email` (string, required)

## Response 401 fields (application/json):

  - `status` (string, required)

  - `error` (string, required)