Roster
List by groups
API Reference
- Introduction
- Authentication
- Authorization
- Endpoints
- Me
- Announcements
- Attachments
- Awards
- Cache
- Calendars
- Categories
- Comments
- Documents
- Events
- Forms
- Groups
- Images
- Messages
- Newsfeed
- Positions
- Qualifications
- Ranks
- Records
- Roster
- Settings
- Specialties
- Statuses
- Submissions
- Tasks
- Units
- Users
Roster
List by groups
The roster endpoint returns a list of groups with their associated units and users already included. The personnel are then sorted by rank, specialty, position and name to assist with creating a roster-like UI.
GET
/
{version}
/
roster
curl --request GET \
--url https://api.perscom.io/{version}/roster \
--header 'Authorization: Bearer <token>'{
"data": [
{
"name": "<string>",
"description": "<string>",
"order": 123,
"hidden": false,
"icon": "<string>",
"image": {
"name": "<string>",
"description": "<string>",
"filename": "<string>",
"path": "<string>",
"image_url": "<string>"
},
"units": [
{
"name": "<string>",
"description": "<string>",
"order": 123,
"hidden": false,
"icon": "<string>",
"image": {
"name": "<string>",
"description": "<string>",
"filename": "<string>",
"path": "<string>",
"image_url": "<string>"
},
"users": [
{
"name": "<string>",
"email": "<string>",
"email_verified_at": "2023-11-07T05:31:56Z",
"phone_number": "<string>",
"position_id": 123,
"rank_id": 123,
"specialty_id": 123,
"status_id": 123,
"unit_id": 123,
"approved": true,
"online": true,
"notes": "<string>",
"notes_updated_at": "2023-11-07T05:31:56Z",
"profile_photo_url": "<string>",
"cover_photo_url": "<string>",
"discord_user_id": "<string>",
"timezone": "<string>",
"last_seen_at": "2023-11-07T05:31:56Z",
"last_assignment_change_date": "2023-11-07T05:31:56Z",
"last_rank_change_date": "2023-11-07T05:31:56Z"
}
]
}
],
"id": 123
}
],
"links": {
"first": "<string>",
"last": "<string>",
"prev": "<string>",
"next": "<string>"
},
"meta": {
"current_page": 123,
"from": 123,
"last_page": 123,
"path": "<string>",
"per_page": 123,
"to": 123,
"total": 123
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The API version to use.
Available options:
v1, v2 Query Parameters
Available options:
image, units, units.image, units.users, units.users.position, units.users.rank, units.users.rank.image, units.users.specialty, units.users.status, units.* Response
200
application/json
OK
Supports HTML.
Will be auto-calculated if nothing is provided.
A valid Heroicon.
Supports HTML.
Will be auto-calculated if nothing is provided.
A valid Heroicon.
Supports HTML.
Was this page helpful?
curl --request GET \
--url https://api.perscom.io/{version}/roster \
--header 'Authorization: Bearer <token>'{
"data": [
{
"name": "<string>",
"description": "<string>",
"order": 123,
"hidden": false,
"icon": "<string>",
"image": {
"name": "<string>",
"description": "<string>",
"filename": "<string>",
"path": "<string>",
"image_url": "<string>"
},
"units": [
{
"name": "<string>",
"description": "<string>",
"order": 123,
"hidden": false,
"icon": "<string>",
"image": {
"name": "<string>",
"description": "<string>",
"filename": "<string>",
"path": "<string>",
"image_url": "<string>"
},
"users": [
{
"name": "<string>",
"email": "<string>",
"email_verified_at": "2023-11-07T05:31:56Z",
"phone_number": "<string>",
"position_id": 123,
"rank_id": 123,
"specialty_id": 123,
"status_id": 123,
"unit_id": 123,
"approved": true,
"online": true,
"notes": "<string>",
"notes_updated_at": "2023-11-07T05:31:56Z",
"profile_photo_url": "<string>",
"cover_photo_url": "<string>",
"discord_user_id": "<string>",
"timezone": "<string>",
"last_seen_at": "2023-11-07T05:31:56Z",
"last_assignment_change_date": "2023-11-07T05:31:56Z",
"last_rank_change_date": "2023-11-07T05:31:56Z"
}
]
}
],
"id": 123
}
],
"links": {
"first": "<string>",
"last": "<string>",
"prev": "<string>",
"next": "<string>"
},
"meta": {
"current_page": 123,
"from": 123,
"last_page": 123,
"path": "<string>",
"per_page": 123,
"to": 123,
"total": 123
}
}