> For the complete documentation index, see [llms.txt](https://docs.imperialcad.app/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.imperialcad.app/api-and-integrations/api-integrations/civilian-endpoints/get-character-vehicles.md).

# Get Character Vehicles

This endpoint allows you to retrieve vehicles registered to a civilian character inside ImperialCAD.

This is intended for integrations that need to sync a character’s vehicle records into an in-game framework, MDT, garage system, or other external resource.

{% hint style="warning" %}
This endpoint requires **an Advanced** ImperialCAD subscription or higher.
{% endhint %}

### getCharacterVehicles

`GET` `https://imperialcad.app/api/1.1/wf/getCharacterVehicles`

***

### Query Parameters

| Name     | Type   | Required | Description                                                   |
| -------- | ------ | -------- | ------------------------------------------------------------- |
| `commId` | string | Yes      | Your ImperialCAD community ID                                 |
| `ssn`    | string | Yes      | The SSN of the civilian character                             |
| `page`   | number | Yes      | Page number to return. Each page can return up to 50 vehicles |

***

### Headers

Use the standard ImperialCAD API headers shown in the API Getting Started documentation.

***

{% tabs %}
{% tab title="Example" %}

```lua
https://imperialcad.app/api/1.1/wf/getCharacterVehicles?commId=idhere&ssn=idhere&page=1
```

{% endtab %}

{% tab title="Response of Example" %}

```lua
{
  "status": "success",
  "page": 1,
  "has_next_page": false,
  "data": [
    {
      "vin": "Z57SM7X7WKLW8AM0Z",
      "plate": "123ABCD",
      "year": "2020",
      "make": "Dpdge",
      "model": "charger",
      "color": "Green"
    }
  ]
}
```

{% endtab %}
{% endtabs %}

***

### Pagination

This endpoint can return up to **100 vehicles total** for a character.

Results are paginated across **two pages**, with a maximum of **50 vehicles per page**.

Use the `page` query parameter to request a specific page.

```
GET https://imperialcad.app/api/1.1/wf/getCharacterVehicles?commId=idhere&ssn=idhere&page=2
```

If `has_next_page` is `true`, another page of results is available.

If `has_next_page` is `false`, there are no additional pages.

***

### Notes

This endpoint looks up vehicles by the civilian character’s SSN.

Use this endpoint when you need to retrieve a character’s registered vehicles from ImperialCAD and sync them with another system.

Vehicle records returned by this endpoint include basic registration information only.

```
```