List Personnel Types

GET

/workforce/personnel-types

GET

/workforce/personnel-types

1 curl -G https://https//https/workforce/personnel-types \
2      -H "{{tenant_key_name}}: X-Tenant-ID" \
3      -H "Content-Type: application/json" \
4      -d per_page=15 \
5      -d page=1 \
6      -d is_active=true

200Retrieved

1 {
2   "personnel_types": [
3     {
4       "id": "pt-001",
5       "name": "Full-Time Employee",
6       "description": "Employees working full-time hours",
7       "is_active": true
8     },
9     {
10       "id": "pt-002",
11       "name": "Part-Time Employee",
12       "description": "Employees working less than full-time hours",
13       "is_active": true
14     },
15     {
16       "id": "pt-003",
17       "name": "Contractor",
18       "description": "External contractors engaged for specific projects",
19       "is_active": true
20     }
21   ],
22   "page": 1,
23   "per_page": 15,
24   "total": 3
25 }

Query parameters

per_pageintegerOptional

Optional: Results per page - default 15

pageintegerOptional

Optional: Page number - default 1

is_activebooleanOptional

Optional: Filter by active status - true|false

Response

Successful response

Headers

Query parameters

Response