Groups

List groups

SecurityToken
Request
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses
200
get/groups/
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

Retrieve group

SecurityToken
Request
path Parameters
group_name
required
string
Responses
200
get/groups/{group_name}/
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

List fees

SecurityToken
Request
path Parameters
group_name
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses
200
get/groups/{group_name}/fees/
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

Retrieve fee

SecurityToken
Request
path Parameters
fee_id
required
string
group_name
required
string
Responses
200
get/groups/{group_name}/fees/{fee_id}/
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

List permissions

SecurityToken
Request
path Parameters
group_name
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses
200
get/groups/{group_name}/permissions/
Response samples
application/json
{
  • "status": "string",
  • "data": {}
}

Retrieve permission

SecurityToken
Request
path Parameters
group_name
required
string
permission_id
required
string
Responses
200
get/groups/{group_name}/permissions/{permission_id}/
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

List tiers

SecurityToken
Request
path Parameters
group_name
required
string
query Parameters
level
number
requirement
string
active
string
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses
200
get/groups/{group_name}/tiers/
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

Retrieve tier

SecurityToken
Request
path Parameters
group_name
required
string
tier_id
required
string
Responses
200
get/groups/{group_name}/tiers/{tier_id}/
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

List tier fees

SecurityToken
Request
path Parameters
group_name
required
string
tier_id
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses
200
get/groups/{group_name}/tiers/{tier_id}/fees/
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

Retrieve tier fee

SecurityToken
Request
path Parameters
fee_id
required
string
group_name
required
string
tier_id
required
string
Responses
200
get/groups/{group_name}/tiers/{tier_id}/fees/{fee_id}/
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

List tier limits

SecurityToken
Request
path Parameters
group_name
required
string
tier_id
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses
200
get/groups/{group_name}/tiers/{tier_id}/limits/
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

Retrieve tier limit

SecurityToken
Request
path Parameters
group_name
required
string
limit_id
required
string
tier_id
required
string
Responses
200
get/groups/{group_name}/tiers/{tier_id}/limits/{limit_id}/
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

List tier requirements

SecurityToken
Request
path Parameters
group_name
required
string
tier_id
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses
200
get/groups/{group_name}/tiers/{tier_id}/requirements/
Response samples
application/json
{}

Retrieve tier requirement

SecurityToken
Request
path Parameters
group_name
required
string
req_id
required
string
tier_id
required
string
Responses
200
get/groups/{group_name}/tiers/{tier_id}/requirements/{req_id}/
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}