blob: 994c4fb2ac768dae683d47a3311367506d57b9a9 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
|
# Teams (Coming Soon!)
Team objects contain aggregated lifetime information about each Team.
## Get a collection of Teams
```shell
curl "https://api.dc01.gamelockerapp.com/shards/na/teams?filter[teamNames]=team1" \
-H "Authorization: Bearer <api-key>" \
-H "Accept: application/vnd.api+json"
```
This endpoint retrieves a collection of up to 6 teams.
<aside class="warning">
Important - Team resources are not yet available in the API.
</aside>
### HTTP Request
`GET https://api.dc01.gamelockerapp.com/teams`
### Query Parameters
Parameter | Default | Description
--------- | ------- | -----------
filter[teamNames] | none | Filters by team name. Usage: filter[teamNames]=team1
filter[teamIds] | none | Filter by team id. Usage: filter[teamIds]=12345
<aside class="success">
Remember — a happy team is an authenticated team!
</aside>
## Get a single Team
```shell
curl "https://api.dc01.gamelockerapp.com/teams/<ID>" \
-H "Authorization: Bearer <api-key>" \
-H "Accept: application/vnd.api+json"
```
```python
```
> The above command returns JSON structured like this:
```json
{
"id": 2,
"name": "Max",
"breed": "unknown",
"fluffiness": 5,
"cuteness": 10
}
```
This endpoint retrieves a specific team.
### HTTP Request
`GET https://api.dc01.gamelockerapp.com/teams/<ID>`
### URL Parameters
Parameter | Description
--------- | -----------
ID | The ID of the team to retrieve
|
