Skip to main content
GET
/
categories
List Categories
curl --request GET \
  --url https://api.g2cplatform.com/v2/categories \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "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
          }
        }
      ]
    }
  ],
  "pagination": {
    "limit": 123,
    "offset": 123,
    "total": 123,
    "hasNext": true,
    "hasPrevious": true
  }
}

Authorizations

​
X-API-Key
string
header
required

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

Query Parameters

​
limit
integer
default:20

Maximum number of categories to return (default: 20, max: 100)

Required range: 1 <= x <= 100
​
offset
integer
default:0

Number of categories to skip (for pagination)

Required range: x >= 0
​
status
enum<string>
default:active

Filter by category status

Available options:
active,
inactive,
all
​
name
string

Filter by category name (partial match)

​
sort
string
default:createdAt:desc

Sort field and direction (format: field:direction)

Example:

"name:asc"

Response

List of categories with their subcategories

​
data
object[]
required
​
pagination
object
required