Skip to main content
GET
Get Lms Categories

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-connector-token
string
required

Query Parameters

ids
string | null

A comma-separated list of LMS Category IDs to filter by.

remote_id
string

The third-party API ID of the matching object.

include_raw_data
boolean
default:false

Whether to include the original data Bindbee fetched from the third-party to produce these models.

Example:

false

status
enum<string>

If provided, will only return categories with this status.

Available options:
ACTIVE,
PENDING,
INACTIVE
Example:

"ACTIVE"

include_custom_fields
boolean
default:false

Whether to include custom fields in the response.

Example:

false

page_size
integer
default:50

Number of results to return per page. Maximum size is 200.

Required range: 1 <= x <= 200
cursor
string

The pagination cursor value.

Response

Successful Response

cursor
string | null
required

Cursor value to fetch next set of items

Example:

"MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"

page_size
integer
required

Indicates the count of items in the response

Example:

50

items
LmsCategory · object[]
required