Skip to content

Commit

Permalink
Document Page parameter in Vehicle listing | REL: #758 (#759)
Browse files Browse the repository at this point in the history
  • Loading branch information
malina-nimbee authored Sep 29, 2023
1 parent 02dd2bd commit 744f656
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion docs/api-basics/vehicles.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,19 @@ One potentially confusing part of Tesla's API is the switching use of the `id` a

For the state and command APIs, you should be using the `id` field. If your JSON parser doesn't support large numbers (>32 bit), then you can use the `id_s` field for a string version of the ID.

## GET `/api/1/vehicles`
## GET `/api/1/vehicles?page={page}`

Retrieve a list of your owned vehicles.

The list is limited to a maximum of 100 entries. Use the `page` GET parameter to iterate over the response page and use
the response `count` variable to determine if another request should be made.

### Request parameters

| Field | Example | Description | Required | Default |
| :----- | :------ | :-------------- | :------- | :------ |
| `page` | `1` | The page number | no | 1 |

### Response

```json
Expand Down

0 comments on commit 744f656

Please sign in to comment.