v1
latestOpenAPI 3.0.02026-07-26254134307.1 KBTime Off
List team time offs
List the time offs of all teammates in a team.
Required scope: time_off:read
get/teams/{team_id}/time_offs
Path parameters
team_idstring required
The team ID
Query parameters
limitinteger
Example:25
Max number of results per page
page_tokenstring
Example:https://yourCompany.api.frontapp.com/endpoint?limit=25&page_token=92f32bcd7625333caf4e0f8fc26d920c812f
Token to use to request the next page
qstring
Search query object with the optional properties active_from and active_until, whose value should be a timestamp in seconds with up to 3 decimal places.
Response
Array of time offs
Example response
{
"_pagination": {
"next": "https://yourCompany.api.frontapp.com/teams/tim_abc123/time_offs?page_token=9fa92a7f385fd7be43f7153055b30e6d"
},
"_links": {
"self": "https://yourCompany.api.frontapp.com/teams/tim_abc123/time_offs"
},
"_results": [
{
"_links": {
"self": "https://yourCompany.api.frontapp.com/time_offs/vcr_1bri",
"related": {
"teammate": "https://yourCompany.api.frontapp.com/teammates/tea_1bri"
}
},
"id": "vcr_1bri",
"name": "Out of office",
"start_at": 1606943265.298,
"end_at": 1607548065.298,
"created_at": 1606943265.298,
"updated_at": 1606943265.298,
"auto_responder": {
"is_enabled": true,
"channel_ids": [
"cha_1bri",
"cha_2bri"
],
"body": "Thanks for reaching out, I will reply when I am back."
}
}
]
}