Skip to main content
GET
/
categories
/
{categoryId}
Get Category
curl --request GET \
  --url https://api.g2cplatform.com/v2/categories/{categoryId} \
  --header 'X-API-Key: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "status": "active",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "metadata": {},
  "statistics": {
    "subcategoryCount": 123,
    "objectCount": 123
  },
  "subcategories": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "categoryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "active",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "metadata": {},
      "statistics": {
        "objectCount": 123
      }
    }
  ]
}

Authorizations

X-API-Key
string
header
required

API key for authenticating requests. Include in X-API-Key header.

Path Parameters

categoryId
string<uuid>
required

Category identifier

Response

Category details with subcategories

id
string<uuid>
required
name
string
required
status
enum<string>
required
Available options:
active,
inactive,
archived
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
description
string
metadata
object
statistics
object
subcategories
object[]

List of subcategories within this category