GET
List subcategories

Authorizations

X-API-Key
string
header
required

ISV / partner credential — public half. Required on every request.

Identifies the integration partner (ISV) making the call. Issued by Dime Trades when the ISV is onboarded and sent on every /partner/* endpoint:

  • On the two partner endpoints that create accounts or issue tokens (POST /partner/customers, POST /partner/customers/login), it is accompanied by X-API-Secret and is the only authentication — there is no user token yet.
  • On every other partner endpoint it is sent alongside the user's Authorization: Bearer <token>: the API key says which platform is calling, the bearer token says which user it is calling for.

Credentials are scoped to one or more brands; using a key with a brandId outside that scope returns 403. Staging and production keys are separate. The key identifies your platform — treat it as a backend credential.

Query Parameters

categoryId
integer

Filter by parent category.

Required range: x >= 1
Example:

34

subCategoryId
integer

Return the children of this subcategory. A leaf id returns an empty list. Mind the capital C.

Required range: x >= 1
Example:

81

isActive
boolean

Accepted for compatibility. Only active subcategories are ever returned, so isActive=false does not return inactive ones.

status
enum<string>

Which event status activeEventsCount should count. Defaults to live and open events together. Subcategories with a count of 0 for the chosen status are not returned, so this also decides which rows appear.

Available options:
pending,
open,
live,
halted,
closed,
settled,
expired,
terminated
withCadence
boolean

Include cadence buckets. Adds virtual CadenceBucket entries to the start of subcategories, and a cadenceSubcategories array to each real subcategory. See the warning above.

page
integer
default:1
Required range: x >= 1
limit
integer
default:10

Page size. Applies to real subcategories only, not to the virtual entries. Rows are ordered by displayOrder, then id, so paging is stable even when displayOrder is 0 throughout.

Required range: x >= 1

Response

Subcategories returned.

data
object
errors
array