Teams: Retrieve One

This documentation entry provides a clear and detailed guide on how to retrieve a specific team using the API, including the necessary parameters, headers, and expected response.

Endpoint

GET /api/teams/{team_id}

Retrieve detailed information about a specific team by its unique identifier.

Request

HTTP Request

GET https://uptimekeep.com/api/teams/{team_id}

Replace {team_id} with the ID of the team you wish to retrieve.

Headers

Header	Type	Description
Authorization	String	Bearer token for API authentication.

Example of a request:

curl --request GET \
--url 'https://uptimekeep.com/api/teams/{team_id}' \
--header 'Authorization: Bearer {api_key}'

Response

A successful response returns a JSON object containing detailed information about the specified team.

Response Example

{
    "data": {
        "id": 1,
        "name": "Example team",
        "team_members": [
            {
                "team_member_id": 1,
                "user_email": "[email protected]",
                "access": {
                    "read": true,
                    "create": true,
                    "update": true,
                    "delete": false
                },
                "status": 1,
                "datetime": "2022-06-05 14:37:10",
                "last_datetime": "2022-06-07 13:04:31"
            }
        ],
        "last_datetime": null,
        "datetime": "2022-04-05 21:08:52"
    }
}

Fields

Data Object

Field	Type	Description
id	Integer	Unique identifier for the team.
name	String	Name of the team.
team_members	Array	List of members in the team, including their access permissions (see below).
last_datetime	String	Timestamp of the last activity related to the team (in YYYY-MM-DD HH:MM:SS format).
datetime	String	Timestamp when the team was created (in YYYY-MM-DD HH:MM:SS format).

Team Members Object

Field	Type	Description
team_member_id	Integer	Unique identifier for the team member.
user_email	String	Email address of the team member.
access	Object	Access permissions for the team member (read, create, update, delete).
status	Integer	Status of the team member (e.g., active, inactive).
datetime	String	Timestamp when the team member was added (in YYYY-MM-DD HH:MM:SS format).
last_datetime	String	Timestamp of the last activity by the team member (in YYYY-MM-DD HH:MM:SS format).

Access Object

Field	Type	Description
read	Boolean	Indicates if the member has read access.
create	Boolean	Indicates if the member has create access.
update	Boolean	Indicates if the member has update access.
delete	Boolean	Indicates if the member has delete access.

Errors

If the request fails, the API will return an error message with an appropriate HTTP status code, such as 404 Not Found if the team ID does not exist.