Read a functional area

Request

Returns one group with its target headcount, the type it is filed under, the training assigned to anyone who joins it, and the conditions that maintain its membership if automatic updating is switched on.

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

Security

default

Path

idintegerrequired

The ID of the functional area.

Rosterfy-Platformstring

curl -i -X GET \
  'https://developer.rosterfy.com/_mock/api-docs/openapi/api/v2/headcount/functionalarea/{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_functional_area_type_id": 1,
    "name": "Guest Services",
    "frontend_name": "Guest Services",
    "code": "GUESTSERVICES",
    "target": 50,
    "auto_update_mode": 0,
    "rules": [],
    "training_ids": [ … ],
    "is_system": 0,
    "deleted_at": null,
    "created_at": "2026-06-09T05:36:16.000000Z",
    "updated_at": "2026-06-09T05:36:16.000000Z",
    "updated_by": 1234,
    "uuid": "270eebe1-bc48-4ecf-a065-2c5ff65b33b0"
  },
  "nice": {
    "rrn": "rrn:local:20101:functional_area:1"
  },
  "relations": {},
  "permissions": {
    "read": true,
    "update": true,
    "delete": true
  }
}