Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document Page parameter in Vehicle listing | REL: #758 #759

Merged
merged 1 commit into from
Sep 29, 2023
Merged

Document Page parameter in Vehicle listing | REL: #758 #759

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion docs/api-basics/vehicles.md
View file
Open in desktop
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