TaskCall User API Calls
User API calls are used to retrieve details of users of an organization. They are an extension to the Incidents API. This documentation contains the schema for making the calls. The calls are subjected to the permissions your organization account has. If your organization does not have the right permissions, then a permission error will be thrown. The same applies for some of the optional fields of the calls.
If this is your first time using the Incidents API, then please refer to the Incidents API Basic Pointers to get started.
User List
Get the list of users of an organization.
- team_ref_id: (string) ID of the team to filter by.
- keywords: (string) Search keywords to filter by.
[
{
"preferred_username":"adsmi",
"display_name":"Adam Hoffman Smith",
"email":"***@apollo.com",
"user_role":"OWNER",
"job_title":"CTO",
"is_locked":false
},
...
]
User Details
Get the details of a user.
- preferred_username: (string) Preferred username of the user.
{
"email":"***@apollo.com",
"first_name":"Ashley",
"last_name":"Haining",
"iso_country_code":"US",
"country_code":"1",
"phone":"***",
"preferred_username":"ashai",
"taskcall_email":"***@apollo.taskcallapp.com",
"timezone":"US/Eastern",
"language":"en",
"profile_picture":"***",
"user_role":"ADMIN",
"job_title":"IT Manager",
"tags":[]
} Create Time Off
Create a time off for a user. During this time off users will not be on-call even if they are in an escalation policy. The time off will be set in the user's timezone.
- preferred_username: (string) Preferred username of the user.
- valid_start: (string) Timestamp the user will be off from.
- valid_end: (string) Timestamp the user will be off till.
{
"preferred_username": "mofab",
"valid_start": "2026-10-11 15:00:00",
"valid_end": "2026-10-11 23:00:00"
}