v1

latestOpenAPI 3.0.0Cognigy Proprietary License2026-07-2239524.1 MB

Projects

Get a Project

Gets data from a Project.

get/v2.0/projects/{projectId}

Path parameters

projectIdstring required

The unique identifier for the Project.

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

Project object retrieved.

namestring

The name of the Project

liveAgentDefaultInboxnumber

Live agent default inbox Id for the project

primaryLocaleReferencestring

_idstring

createdAtinteger

Unix-timestamp

lastChangedinteger

Unix-timestamp

createdBystring

lastChangedBystring

Example response

{
  "name": "New Project",
  "color": "none",
  "createdAt": 1694518620,
  "lastChanged": 1694518620
}