Skip to content
Letterhead Letterhead Letterhead Help Center
Admin Tools

Get team (Beta)

GET
/api/v3/teams

Lookup your team with this endpoint, which as a v3 route requires a company-level API key. Note that as a beta, the shape of the API response might change.

api
string
Example
true

required | When set to true, this endpoint will accept authorization with your API Key.

Get team

Media type text/plain
Examples
Example Get team
{
"items": [
{
"email": "[email protected]",
"name": "Michael",
"permissions": [
{
"channelSlug": "",
"channelTitle": "",
"platformUserUniqueId": "abcdefhi",
"authZeroUuid": "auth0|abcdefhi",
"roleName": "Tenant administrator",
"created_at": "2023-12-07 07:55:29",
"updated_at": "2026-02-11 14:55:26"
}
],
"picture": "",
"platformUserUniqueId": "abcdefhi",
"surname": "Su",
"companyUuid": 0
},
],
"message": "",
"total": 1
}
:status
string
Example
200
access-control-allow-credentials
string
Example
true
access-control-allow-origin
string
Example
*
access-control-max-age
string
Example
86400
alt-svc
string
Example
h3=":443"; ma=2592000
cache-control
string
Example
no-cache, private
date
string
Example
Tue, 21 Apr 2026 12:05:41 GMT
server
string
Example
nginx/1.27.3
via
string
Example
1.1 google
x-powered-by
string
Example
PHP/7.4.33

Still can’t find what you need? Contact support.