Skip to content
API reference
/
/
Read a venue

Read a venue

Request

Returns one venue with its address, the training assigned to anyone who accepts a role there, and the location it belongs to. nice carries the address pre-formatted for display, both as a block and on one line.

The venue has to belong to the location in the path.

permissions.delete reflects whether this particular venue can be removed, which depends on whether roles are still recruiting at it.

Security
default
Path
location_idintegerrequired

The ID of the location.

idintegerrequired

The ID of the venue.

Headers
Rosterfy-Platformstring
curl -i -X GET \
  'https://developer.rosterfy.com/_mock/api-docs/openapi/api/v2/headcount/location/{location_id}/venue/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Rosterfy-Platform: admin'

Responses

Bodyapplication/json
objectobject
niceobject
relationsobject
permissionsobject
Response
{
  "object": {
    "id": 1,
    "headcount_location_id": 1,
    "name": "North Gate",
    "frontend_name": "North Gate",
    "code": "NORTHGATE",
    "is_virtual": 0,
    "description": "<p>Main pedestrian entrance.</p>",
    "is_system": 0,
    "training_ids": [ … ],
    "deleted_at": null,
    "created_at": "2026-06-09T05:36:16.000000Z",
    "updated_at": "2026-06-09T05:36:16.000000Z",
    "uuid": "f64e8d2b-7f0d-42fb-91bc-98a098a7f191",
    "address": { … }
  },
  "nice": {
    "rrn": "rrn:local:20101:venue:1",
    "address": "1 Example Street\nExample City\nExample Region\nAustralia\n1000",
    "address_oneline": "1 Example Street, Example City, Example Region, Australia, 1000",
    "address.country": "Australia",
    "address.country:raw": "AUS",
    "address.city": "Example City",
    "address.region": "Example Region",
    "address.region:raw": "Example Region",
    "address.postcode": "1000",
    "address.street_address_1": "1 Example Street",
    "address.street_address_2": null,
    "address.street_address_3": null,
    "address.latitude": null,
    "address.longitude": null,
    "location_name": "Main Campus",
    "headcount_location_type_name": "Stadium",
    "headcount_location_type_id": 1
  },
  "relations": {
    "location": { … }
  },
  "permissions": {
    "read": true,
    "update": true,
    "delete": true
  }
}