Skip to main content
GET
/
api-category
/
v1
/
category
/
source
Get category source inclusions
curl --request GET \
  --url https://live.copilot.fabric.inc/api-category/v1/category/source \
  --header 'Authorization: Bearer <token>' \
  --header 'x-site-context: <x-site-context>'
{
  "totalSize": 100,
  "pageSize": 10,
  "pages": 10,
  "id": "6170135a49b4af38190970fe",
  "nodeId": 12,
  "name": "Furniture",
  "sources": [
    {
      "id": "61701259125b7225cbfb21b9",
      "nodeId": 12,
      "name": "picture",
      "breadcrumbString": "PRIMARY/Furniture/Chairs"
    }
  ]
}

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. id and nodeId are the two identifiers of a category and one of them must be specified.

​
nodeId
number

Numeric category ID. id and nodeId are the two identifiers of a category and one of them must be specified.

​
status
enum<string>

Status of Category source. If omitted, 'ASSIGNED' status is used as default.

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 (categories)

Example:

100

​
pageSize
number

Number of records (categories) 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:

"6170135a49b4af38190970fe"

​
nodeId
number

Numeric category ID

Example:

12

​
name
string

Category name

Example:

"Furniture"

​
sources
object[]