Skip to main content
GET
/
api-category
/
v1
/
category
/
attribute
Get assigned category attributes
curl --request GET \
  --url https://live.copilot.fabric.inc/api-category/v1/category/attribute \
  --header 'Authorization: Bearer <token>' \
  --header 'x-site-context: <x-site-context>'
{
  "totalSize": 100,
  "pageSize": 10,
  "pages": 10,
  "id": "619a8ba6f1875f6dbcaf0521",
  "nodeId": 2,
  "name": "electronics",
  "attributes": [
    {
      "id": "619a8ba6f1875f6dbcaf0521",
      "name": "notes",
      "description": "Notes for this particular category.",
      "type": "TEXT",
      "value": "Unable to fulfill demand."
    }
  ]
}

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 category ID. Either id or nodeId must be specified.

​
nodeId
integer

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

​
status
enum<string>

Attribute status. When id or nodeId is specified along with status = Assigned, the response is faster because the data is fetched from cache. When the status is Unassigned, the data is fetched from the DB and the response could take longer.

Available options:
ASSIGNED,
UNASSIGNED
Example:

"ASSIGNED"

​
page
number
required

Page number to be retrieved. Applicable only in a paginated response and always paired with size.

​
size
number
required

Number of records per page. Applicable only in a paginated response and always paired with page.

Response

OK

​
totalSize
number

Total number of records (attributes)

Example:

100

​
pageSize
number

Number of records (attributes) in a page

Example:

10

​
pages
number

Number of pages for the given pageSize

Example:

10

​
id
string

A 24-character system-generated category ID

Example:

"619a8ba6f1875f6dbcaf0521"

​
nodeId
number

Numeric category ID

Example:

2

​
name
string
Example:

"electronics"

​
attributes
object[]