View Team via API
This method allows you to view details for a specific team.
Tip: You can explore and test this endpoint interactively using our OpenAPI documentation.
URL
/teams/:identifier
HTTP Method
GET
Supported Parameters
| Parameter | Type | Description |
|---|---|---|
identifier |
String | The team identifier (in the URL) |
Example cURL Request
curl -H "Content-type: application/json" \
-H "Accept: application/json" \
--user adam@atechmedia.com:my-api-key \
https://test.deployhq.com/teams/abc123-def456
Example Response
{
"identifier": "abc123-def456",
"name": "Engineering",
"is_admin": false,
"can_manage_users": false,
"can_manage_billing": false,
"can_manage_agents": false,
"can_create_projects": true,
"all_projects_allowed": false,
"members": [
{
"id": 12345,
"identifier": "9e11def8-8c43-454e-8c99-3c5b9cf08396",
"first_name": "John",
"last_name": "Doe",
"email_address": "john@example.com"
}
],
"project_assignments": [
{
"name": "My Website",
"identifier": "my-website",
"can_deploy_all": true,
"can_update_config": false,
"can_manage_config_files": false
}
]
}
Notes
- Returns the full team details including members and project assignments
- The
membersarray contains each team member's user details - The
project_assignmentsarray is only populated whenall_projects_allowedisfalse