Skip to main content
GET
/
collections
/
{collectionId}
Get collection details
curl --request GET \
  --url https://api.portkey.ai/v1/collections/{collectionId} \
  --header 'x-portkey-api-key: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "slug": "<string>",
  "parent_collection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_default": true,
  "status": "active",
  "created_at": "2023-11-07T05:31:56Z",
  "last_updated_at": "2023-11-07T05:31:56Z",
  "child_collections": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "last_updated_at": "2023-11-07T05:31:56Z",
      "collection_details": {
        "child_collections_count": 123,
        "prompts_count": 123,
        "child_collections_last_updated_at": "2023-11-07T05:31:56Z",
        "prompts_last_updated_at": "2023-11-07T05:31:56Z"
      }
    }
  ]
}

Authorizations

​
x-portkey-api-key
string
header
required

Path Parameters

​
collectionId
string
required

ID or slug of the collection

Response

Collection details

​
id
string<uuid>
​
name
string
​
workspace_id
string<uuid>
​
slug
string
​
parent_collection_id
string<uuid> | null
​
is_default
boolean
​
status
enum<string>
Available options:
active,
archived
​
created_at
string<date-time>
​
last_updated_at
string<date-time>
​
child_collections
object[]