List roles

​

Catalog of performing/production roles (instruments + crew) — e.g. "Violin/Fiddle", "Bass Player", "FOH Engineer".

Query Parameters

  • limit
    Type: integer
    min:  
    0
    max:  
    200

    Page size, 50 by default, 200 at most.

  • offset
    Type: integer
    min:  
    0

    Records to skip.

  • sort
    Type: string

    Comma-separated fields; prefix with - for descending. Sortable: label, status, teamId, order, category, createdTime, lastEditedTime, id. Default: order,label.

  • fields
    Type: string

    Comma-separated subset of fields to return. id is always included.

  • filter[label]

    Shorthand filter[label]=value means equals. Operators: equals, does_not_equal, contains, does_not_contain, starts_with, ends_with, is_empty, is_not_empty.

    • Type: string

      Shorthand filter[label]=value means equals. Operators: equals, does_not_equal, contains, does_not_contain, starts_with, ends_with, is_empty, is_not_empty.

  • filter[status]

    Shorthand filter[status]=value means equals. Operators: equals, does_not_equal, is_empty, is_not_empty.

    • Type: "inactive" or "active"enum

      Shorthand filter[status]=value means equals. Operators: equals, does_not_equal, is_empty, is_not_empty.

  • filter[teamId]

    Shorthand filter[teamId]=value means equals. Operators: equals, does_not_equal, is_empty, is_not_empty.

    • Type: stringFormat: uuid

      Shorthand filter[teamId]=value means equals. Operators: equals, does_not_equal, is_empty, is_not_empty.

  • filter[order]

    Shorthand filter[order]=value means equals. Operators: equals, does_not_equal, greater_than, less_than, greater_than_or_equal_to, less_than_or_equal_to, is_empty, is_not_empty.

    • Type: number

      Shorthand filter[order]=value means equals. Operators: equals, does_not_equal, greater_than, less_than, greater_than_or_equal_to, less_than_or_equal_to, is_empty, is_not_empty.

  • filter[category]

    Shorthand filter[category]=value means equals. Operators: equals, does_not_equal, contains, does_not_contain, starts_with, ends_with, is_empty, is_not_empty.

    • Type: string

      Shorthand filter[category]=value means equals. Operators: equals, does_not_equal, contains, does_not_contain, starts_with, ends_with, is_empty, is_not_empty.

  • filter[createdTime]

    Shorthand filter[createdTime]=value means equals. Operators: equals, before, after, on_or_before, on_or_after, is_empty, is_not_empty.

    • Type: stringFormat: date-time

      Shorthand filter[createdTime]=value means equals. Operators: equals, before, after, on_or_before, on_or_after, is_empty, is_not_empty.

  • filter[lastEditedTime]

    Shorthand filter[lastEditedTime]=value means equals. Operators: equals, before, after, on_or_before, on_or_after, is_empty, is_not_empty.

    • Type: stringFormat: date-time

      Shorthand filter[lastEditedTime]=value means equals. Operators: equals, before, after, on_or_before, on_or_after, is_empty, is_not_empty.

Responses

  • application/json
  • application/json
  • application/json
  • application/json
Request Example for get/roles
curl 'https://api.weddingoperatingsystems.com/api/v1/roles?limit=50&offset=0&sort=order%2Clabel' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "label": null,
      "status": "inactive",
      "teamId": null,
      "order": null,
      "category": null,
      "createdTime": "2026-09-30T06:22:05.749Z",
      "lastEditedTime": "2026-09-30T06:22:05.749Z"
    }
  ],
  "meta": {
    "total": 1,
    "limit": 1,
    "offset": 1
  }
}

A page of roles.