List custom fields

​

The band’s own fields on core tables. Each row is one real column, named with the x_ prefix, on the table it belongs to. Retiring a field hides it everywhere and keeps its data.

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, entity, key, field_type, options, relation, required, description, order, status, created_time, last_edited_time, id. Default: entity,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.

  • filter[entity]

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

  • filter[key]

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

  • filter[field_type]

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

  • filter[options]

    Shorthand filter[options]=value means equals. Operators: contains, does_not_contain, is_empty, is_not_empty.

  • filter[relation]

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

  • filter[required]

    Shorthand filter[required]=value means equals. Operators: equals, does_not_equal.

  • filter[description]

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

  • filter[status]

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

  • filter[created_time]

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

  • filter[last_edited_time]

    Shorthand filter[last_edited_time]=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/custom-fields
curl 'https://api.weddingoperatingsystems.com/api/v1/custom-fields?limit=50&offset=0&sort=entity%2Corder%2Clabel' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "label": null,
      "entity": null,
      "key": null,
      "field_type": "rich_text",
      "options": [
        "string"
      ],
      "relation": null,
      "required": true,
      "description": null,
      "order": null,
      "status": "active",
      "created_time": "2026-10-05T17:38:27.329Z",
      "last_edited_time": "2026-10-05T17:38:27.329Z"
    }
  ],
  "meta": {
    "total": 1,
    "limit": 1,
    "offset": 1
  }
}

A page of custom fields.

A Wedding Operating Systems, LLC product hireorpheus.com