Skip to main content
GET
/
api-category
/
v1
/
category
/
tree
Get category tree
curl --request GET \
  --url https://live.copilot.fabric.inc/api-category/v1/category/tree \
  --header 'Authorization: Bearer <token>' \
  --header 'x-site-context: <x-site-context>'
{
  "id": "6196b45b5cb04b7ce167cb46",
  "nodeId": 16,
  "name": "PCs",
  "hierarchy": "ALTERNATE",
  "isActive": true,
  "attributes": [
    {
      "id": "619a8ba6f1875f6dbcaf0521",
      "name": "notes",
      "description": "Notes for this particular category.",
      "type": "TEXT",
      "value": "Unable to fulfill demand."
    }
  ],
  "children": [
    {
      "id": "619973877a22c466eee93219",
      "name": "Apple",
      "breadcrumbs": [
        {
          "id": "6196b44a5cb04b7ce167cb34",
          "nodeId": 10,
          "name": "Computers",
          "level": 0,
          "hierarchy": "ALTERNATE",
          "isActive": true,
          "createdOn": "2022-03-09T23:37:54.086Z",
          "modifiedOn": "2022-03-09T23:37:54.086Z"
        }
      ],
      "attributes": [
        {
          "id": "619a8ba6f1875f6dbcaf0521",
          "name": "notes",
          "description": "Notes for this particular category.",
          "type": "TEXT",
          "value": "Unable to fulfill demand."
        }
      ],
      "children": "<array>"
    }
  ],
  "createdOn": "2022-03-09T23:37:54.086Z",
  "modifiedOn": "2022-03-09T23:37:54.086Z"
}

Authorizations

​
Authorization
string
header
required

S2S access token (JWT) from fabric Identity service (during Login)

Headers

​
x-site-context
string
required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Example:

"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"

Query Parameters

​
id
string

A 24-character system-generated ID of root category. Either id or nodeId must be specified.

​
nodeId
integer

Numeric category ID. Either id or nodeId must be specified.

​
depth
number

Limits the size of the hierarchical category tree returned in the response. Depth of 0 means no children categories, attributes, or breadcrumbs, are included in the response. Unless depth is specified, entire category is returned up to the last set of categories (that have no more children categories).

​
excludeAttributes
boolean

Set true to exclude attributes from both parent and children objects or false to include attributes in both parent and children details.
The default setting false.

​
excludeBreadcrumbs
boolean

Set true to exclude breadcrumbs from both parent and children objects or false to include breadcrumbs in both parent and children details.
The default setting false.

​
excludeItemIds
boolean

Set true to exclude item IDs from both parent and children objects or false to include item IDs in both parent and children details.
The default setting false.

​
onlyIncludeAttributes
string[]

Attributes are included based on their exact, case-sensitive names. For example, if you specify the values as xyZ and Abc, the response will include these attributes in both parent and child objects.

Response

OK

​
id
string

A 24-character system-generated category ID

Example:

"6196b45b5cb04b7ce167cb46"

​
nodeId
number

Numeric category ID

Example:

16

​
name
string

Category name

Example:

"PCs"

​
hierarchy
enum<string>

Category type

Available options:
PRIMARY,
ALTERNATE
Example:

"ALTERNATE"

​
isActive
boolean

true: Category is Active
false: Category is Inactive
Note: Inactive status is not applicable for Primary category.

Example:

true

​
attributes
object[]

Details of attributes belonging to this category

​
children
object[]

Children categories of this category

​
createdOn
string

Time of category creation (UTC format)

Example:

"2022-03-09T23:37:54.086Z"

​
modifiedOn
string

Time when category was last updated (UTC format)

Example:

"2022-03-09T23:37:54.086Z"