Teams API Documentation

Retrieve all

Endpoint

GET https://up-time.io/api/teams/

Example

curl --request GET \
--url 'https://up-time.io/api/teams/' \
--header 'Authorization: Bearer {api_key}' \

Parameters	Details	Description
page	Optional Integer	The page number that you want results from. Defaults to `1`.
results_per_page	Optional Integer	How many results you want per page. Allowed values are: `10` , `25` , `50` , `100` , `250` , `500`. Defaults to `25`.

Response example

{
    "data": [
        {
			"id": 1,
			"name": "Example team",
			"team_members": [
				{
					"team_member_id": 1,
					"user_email": "hello@example.com",
					"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://up-time.io/api/teams?&page=1",
        "last": "https://up-time.io/api/teams?&page=1",
        "next": null,
        "prev": null,
        "self": "https://up-time.io/api/teams?&page=1"
    }
}

Retrieve one

Endpoint

GET https://up-time.io/api/teams/{team_id}

Example

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

Response example

{
    "data": {
        "id": 1,
        "name": "Example team",
        "team_members": [
            {
                "team_member_id": 1,
                "user_email": "hello@example.com",
                "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"
    }
}

Create

Endpoint

POST https://up-time.io/api/teams

Parameters	Details	Description
name	Required String	-

Example

curl --request POST \
--url 'https://up-time.io/api/teams' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=My team' \

Response example

{
    "data": {
        "id": 1
    }
}

Update

Endpoint

POST https://up-time.io/api/teams/{team_id}

Parameters	Details	Description
name	Optional String	-

Example

curl --request POST \
--url 'https://up-time.io/api/teams/{team_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=My new team name' \

Response example

{
  "data": {
    "id": 1
  }
}

Delete

Endpoint

DELETE https://up-time.io/api/teams/{team_id}

Example

curl --request DELETE \
--url 'https://up-time.io/api/teams/{team_id}' \
--header 'Authorization: Bearer {api_key}' \