Skip to content

Venue

Example data

{
  "type": "venues",
  "id": "22222222-2222-2222-2222-222222222222",
  "attributes": {
    "name": "Pizza Restaurant",
    "country": "United Kingdom",
    "country-code": "GB",
    "city": "London",
    "address": "Trafalgar Square 1",
    "language": "en",
    "created-at": "2012-01-01T00:00:00.001000+00:00",
    "slug": "pizza-restaurant",
    "status": "active",
    "identifier": "",
    "features": [
      "autologin",
      "reviews"
    ]
  },
  "relationships": {
    "project": {
      "data": {
        "type": "projects",
        "id": "11111111-1111-1111-1111-111111111111"
      }
    }
  }
}

Attributes

Name Description
name Display name of the venue
country Country name
country-code Country code as defined by ISO 3166-1 alpha-2
city City name
address Address
language Primary language for the venue as defined by ISO 639-1
created-at Datetime when the venue was created as defined by ISO 8601
slug A short identifier, can't be changed.
status Current venue service status - trial, active or trial-expired, payment-overdue, client-cancelled for disabled venues. Showcase venues can also have internal or partner-demo status.
identifier Optional identifier added by the owner
features A list of enabled features.

Relationships

Name Resource
project Project