Skip to main content
GET
/
v2.0
/
projects
/
{projectId}
Get a Project
curl --request GET \
  --url 'https://api-trial.cognigy.ai/new/v2.0/projects/{projectId}?api_key=' \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-Key: <api-key>'
{
  "name": "New Project",
  "color": "blue",
  "handoverConfiguration": {
    "setupLiveAgentInbox": true,
    "whisperAssistConfiguration": "none"
  },
  "liveAgentDefaultInbox": 123,
  "primaryLocaleReference": "<string>",
  "_id": "<string>",
  "createdAt": 1694518620,
  "lastChanged": 1694518620,
  "createdBy": "<string>",
  "lastChangedBy": "<string>"
}

Authorizations

​
X-API-Key
string
header
required

Supply the API Key in the HTTP-Header

​
api_key
string
query
required

Supply the API Key in the Url-Query

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
Accept
enum<string>

The default media type is application/hal+json. Use application/json for pure data results.

Available options:
application/json,
application/hal+json,
application/xml,
text/xml,
text/csv

Path Parameters

​
projectId
string
required
Required string length: 24

Response

Returns Project Object

The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.

​
name
string

The name of the Project

Example:

"New Project"

​
color
Available options:
aliceBlue,
antiqueWhite,
aqua,
aquamarine,
azure,
beige,
bisque,
black,
blanchedAlmond,
blue,
blueViolet,
brown,
burlyWood,
cadetBlue,
chartreuse,
chocolate,
coral,
cornflowerBlue,
cornsilk,
crimson,
cyan,
darkBlue,
darkCyan,
darkGoldenRod,
darkGray,
darkGrey,
darkGreen,
darkKhaki,
darkMagenta,
darkOliveGreen,
darkOrange,
darkOrchid,
darkRed,
darkSalmon,
darkSeaGreen,
darkSlateBlue,
darkSlateGray,
darkSlateGrey,
darkTurquoise,
darkViolet,
deepPink,
deepSkyBlue,
dimGray,
dimGrey,
dodgerBlue,
fireBrick,
floralWhite,
forestGreen,
fuchsia,
gainsboro,
ghostWhite,
gold,
goldenRod,
gray,
grey,
green,
greenYellow,
honeyDew,
hotPink,
indianRed,
indigo,
ivory,
khaki,
lavender,
lavenderBlush,
lawnGreen,
lemonChiffon,
lightBlue,
lightCoral,
lightCyan,
lightGoldenRodYellow,
lightGray,
lightGrey,
lightGreen,
lightPink,
lightSalmon,
lightSeaGreen,
lightSkyBlue,
lightSlateGray,
lightSlateGrey,
lightSteelBlue,
lightYellow,
lime,
limeGreen,
linen,
magenta,
maroon,
mediumAquaMarine,
mediumBlue,
mediumOrchid,
mediumPurple,
mediumSeaGreen,
mediumSlateBlue,
mediumSpringGreen,
mediumTurquoise,
mediumVioletRed,
midnightBlue,
mintCream,
mistyRose,
moccasin,
navajoWhite,
navy,
oldLace,
olive,
oliveDrab,
orange,
orangeRed,
orchid,
paleGoldenRod,
paleGreen,
paleTurquoise,
paleVioletRed,
papayaWhip,
peachPuff,
peru,
pink,
plum,
powderBlue,
purple,
rebeccaPurple,
red,
rosyBrown,
royalBlue,
saddleBrown,
salmon,
sandyBrown,
seaGreen,
seaShell,
sienna,
silver,
skyBlue,
slateBlue,
slateGray,
slateGrey,
snow,
springGreen,
steelBlue,
tan,
teal,
thistle,
tomato,
turquoise,
violet,
wheat,
white,
whiteSmoke,
yellow,
yellowGreen,
none,
transparent
Example:

"blue"

​
handoverConfiguration
object
​
liveAgentDefaultInbox
number

Live agent default inbox Id for the project

​
primaryLocaleReference
string
Required string length: 24
​
_id
string
Required string length: 24
​
createdAt
integer

Unix-timestamp

Required range: 0 <= x <= 2147483647
Example:

1694518620

​
lastChanged
integer

Unix-timestamp

Required range: 0 <= x <= 2147483647
Example:

1694518620

​
createdBy
string
Required string length: 24
​
lastChangedBy
string
Required string length: 24