Teams: Retrieve All

This documentation entry provides a comprehensive guide to using the "Retrieve All" teams endpoint, including all relevant details about the request, response, and data structures.

Endpoint

GET /api/teams/

Retrieve a list of all teams associated with your account.

Request

HTTP Request

GET https://uptimekeep.com/api/teams/

Headers

Header	Type	Description
Authorization	String	Bearer token for API authentication.

Query Parameters

Parameter	Type	Description	Default Value
page	Integer	(Optional) The page number to retrieve.	1
results_per_page	Integer	(Optional) Number of results per page. Allowed values: 10, 25, 50, 100, 250, 500, 1000.	25

Example of a request:

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

Response

A successful response returns a JSON object with the list of teams and associated metadata.

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"
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://uptimekeep.com/api/teams?&page=1",
        "last": "https://uptimekeep.com/api/teams?&page=1",
        "next": null,
        "prev": null,
        "self": "https://uptimekeep.com/api/teams?&page=1"
    }
}

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.

Meta Object

Field	Type	Description
page	Integer	Current page number of the results.
results_per_page	Integer	Number of results per page.
total	Integer	Total number of teams.
total_pages	Integer	Total number of pages available based on the current query.

Links Object

Field	Type	Description
first	String	URL of the first page of results.
last	String	URL of the last page of results.
next	String	URL of the next page of results (if applicable).
prev	String	URL of the previous page of results (if applicable).
self	String	URL of the current page of results.

Errors

If the request fails, the API will return an error message with an appropriate HTTP status code.