List ensemble roles

​

Composition junction: which roles make up an ensemble (the prefab template). Materialized into gig_roles at apply time — never a live link that mutates history.

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: name, ensembleId, roleId, order, createdTime, lastEditedTime, id. Default: order,createdTime.

  • fields
    Type: string

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

  • filter[name]

    Shorthand filter[name]=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[name]=value means equals. Operators: equals, does_not_equal, contains, does_not_contain, starts_with, ends_with, is_empty, is_not_empty.

  • filter[ensembleId]

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

    • Type: stringFormat: uuid

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

  • filter[roleId]

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

    • Type: stringFormat: uuid

      Shorthand filter[roleId]=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[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/ensemble-roles
curl 'https://api.weddingoperatingsystems.com/api/v1/ensemble-roles?limit=50&offset=0&sort=order%2CcreatedTime' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": null,
      "ensembleId": null,
      "roleId": null,
      "order": 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 ensemble roles.