API

List Spot member custom roles

GET /v1/spotMemberCustomRole

List Spot member custom roles

Query parameters

  • page integer | null

    The page number in a paginated set of results

  • limit integer | null

    The limit of results to be returned per page

  • label[eq] string

    Search custom role with a specified label

  • label[contains] string

    Search custom role that contains this value in his label

  • label[in] array[string]

    Search custom role which have the following label

Responses

  • 200 application/json

    Custom roles returned successfully

    Hide response attributes Show response attributes object
    • items array[object] Required

      The items found

      Hide items attributes Show items attributes object
      • id string Required

        The id of the custom role.

      • label string Required

        The label of the custom role.

      • description string Required

        The description of the custom role.

      • permissions array[string] Required

        The permissions of the custom role.

        Values are live.*, live.full.*, live.limited.*, moderation.*, spot.member.invite.*, course.limited.*, course.full.*, collection.full.*, or collection.limited.*.

    • total integer Required

      The total number of items found
  • 400

    Malformed payload

GET /v1/spotMemberCustomRole 
curl \
 --request GET 'https://openapi.meltingspot.io/v1/spotMemberCustomRole'
Response examples (200) 
{
  "items": [
    {
      "id": "string",
      "label": "string",
      "description": "string",
      "permissions": [
        "live.*"
      ]
    }
  ],
  "total": 42
}