Staff
Retrieve Assignments
API Documentation
Activity
- In-Game Tracking
- Users
- Sessions
- GETRetrieve Leaderboard
Order Logging
Staff
Workspace
- GETRetrieve a Workspace
- POSTUpdate a Workspace
- GETList Games
- POSTCreate Game
- DELDelete a Game
- GETList Roles
- POSTCreate a Role
- PUTUpdate Role
- DELDelete a Role
- GETList logbook templates
- GETRetrieve Logbook Template
- POSTCreate a Logbook Template
- PATCHUpdate a Logbook Template
- DELDelete a Logbook Template
- GETRetrieve GApps Config
- POSTSet GApps Service Account
- PATCHUpdate GApps Config
- DELDelete GApps Config
- GETGet Trello Config
- GETGet Trello boards
- POSTSet Trello board
- POSTSet Trello format
- DELDisconnect Trello board
- DELDelete Trello Config
- GETRetrieve Schedules
- POSTCreate a Schedule
- POSTUpdate a Schedule
Trello Integration
Bans (Invite Only)
Connections
Staff
Retrieve Assignments
Retrieve assignment information for a staff member
GET
/
staff
/
assignments
/
{workspaceId}
/
{staffId}
curl --request GET \
--url https://api.hyra.io/staff/assignments/{workspaceId}/{staffId} \
--header 'Authorization: Bearer <token>'
{
"assigned": [
{
"active": true,
"_id": "<string>",
"target": 123,
"target_type": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"description": "<string>",
"completed": 123,
"due": "2023-11-07T05:31:56Z"
}
],
"history": [
{
"_id": "<string>",
"week_start": "2023-11-07T05:31:56Z",
"week_end": "2023-11-07T05:31:56Z",
"week_number": 123,
"year": 123,
"assignment": "<string>",
"assignment_name": "<string>",
"marked_at": "2023-11-07T05:31:56Z",
"passed": true,
"target": 123,
"target_type": "<string>",
"achieved": 123,
"timeoff": true
}
]
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Response
200 - application/json
Default Response
curl --request GET \
--url https://api.hyra.io/staff/assignments/{workspaceId}/{staffId} \
--header 'Authorization: Bearer <token>'
{
"assigned": [
{
"active": true,
"_id": "<string>",
"target": 123,
"target_type": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"description": "<string>",
"completed": 123,
"due": "2023-11-07T05:31:56Z"
}
],
"history": [
{
"_id": "<string>",
"week_start": "2023-11-07T05:31:56Z",
"week_end": "2023-11-07T05:31:56Z",
"week_number": 123,
"year": 123,
"assignment": "<string>",
"assignment_name": "<string>",
"marked_at": "2023-11-07T05:31:56Z",
"passed": true,
"target": 123,
"target_type": "<string>",
"achieved": 123,
"timeoff": true
}
]
}