Skip to content

Read a location

Request

Returns one location with its code, the type it is filed under and the training assigned to anyone who accepts a role there.

permissions.delete reflects whether this particular location can be removed, which depends on whether roles are still recruiting at its venues.

Security
default
Path
idintegerrequired

The ID of the location.

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

Responses

Bodyapplication/json
objectobject
niceobject
relationsobject
permissionsobject
Response
{ "object": { "id": 1, "account_id": 20101, "headcount_location_type_id": 1, "name": "Main Campus", "frontend_name": "Main Campus", "code": "MAINCAMPUS", "training_ids": [ … ], "is_system": 0, "deleted_at": null, "created_at": "2026-06-09T05:36:16.000000Z", "updated_at": "2026-06-09T05:36:16.000000Z", "uuid": "ec98790e-5bab-4ad7-9357-31556e2efbc4" }, "nice": { "rrn": "rrn:local:20101:location:1", "headcount_location_type_name": "Stadium" }, "relations": { "headcount_location_type": { … } }, "permissions": { "read": true, "update": true, "delete": true } }