List venues

​

A place gigs happen, with the logistics every crew needs on arrival.

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, street1, street2, city, stateRegion, postalCode, country, website, phone, loadInNotes, parkingNotes, electricalNotes, elevatorNotes, notes, createdTime, lastEditedTime, id. Default: name.

  • 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[street1]

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

  • filter[street2]

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

  • filter[city]

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

  • filter[stateRegion]

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

  • filter[postalCode]

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

  • filter[country]

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

  • filter[website]

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

    • Type: stringFormat: uri

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

  • filter[phone]

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

  • filter[loadInNotes]

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

  • filter[parkingNotes]

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

  • filter[electricalNotes]

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

  • filter[elevatorNotes]

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

  • filter[notes]

    Shorthand filter[notes]=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[notes]=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/venues
curl 'https://api.weddingoperatingsystems.com/api/v1/venues?limit=50&offset=0&sort=name' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": null,
      "street1": null,
      "street2": null,
      "city": null,
      "stateRegion": null,
      "postalCode": null,
      "country": null,
      "website": null,
      "phone": null,
      "loadInNotes": null,
      "parkingNotes": null,
      "electricalNotes": null,
      "elevatorNotes": null,
      "notes": null,
      "createdTime": "2026-09-30T06:22:05.745Z",
      "lastEditedTime": "2026-09-30T06:22:05.745Z"
    }
  ],
  "meta": {
    "total": 1,
    "limit": 1,
    "offset": 1
  }
}

A page of venues.