Get Pinned Resources - Cognigy Documentation

GET

v2.0

users

pinned

Get Pinned Resources

curl --request GET \
  --url https://api-trial.cognigy.ai/new/v2.0/users/me/pinned \
  --header 'X-API-Key: <api-key>'

{
  "type": "project",
  "pinnedIds": [
    "<string>"
  ]
}

X-API-Key

string

header

required

Supply the API Key in the HTTP-Header

resourceType

enum<string>

required

The type of a pinnable resource

Available options:

project

Example:

"project"

Returns list of pinnedResources object

type

enum<string>

The type of a pinnable resource

Available options:

project

Example:

"project"

pinnedIds

string[]

Required string length: 24

Pattern: ^[a-z0-9]{24}$

⌘I

Get Pinned Resources

curl --request GET \
  --url https://api-trial.cognigy.ai/new/v2.0/users/me/pinned \
  --header 'X-API-Key: <api-key>'

{
  "type": "project",
  "pinnedIds": [
    "<string>"
  ]
}

Documentation Index