> 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.md).

# Get Character

This endpoint allows you to get a character's information.

{% hint style="warning" %}
This endpoint requires **any** ImperialCAD subscription.
{% endhint %}

### GetCharacter(data, callback)

<mark style="color:orange;">`GET`</mark> `https://imperialcad.app/api/1.1/wf/getcharacter`

***

#### Parameters

| Name          | Type   | Description       |
| ------------- | ------ | ----------------- |
| `charid`      | string | Citizen ID        |
| `communityid` | string | Your Community ID |

***

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

```lua
exports["ImperialCAD"]:GetCharacter("JD321", "myCommIdHere", function(success, data)
  if success then print(json.encode(data)) else print("Failed:", data) end
end)
```

{% endtab %}

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

```lua
{
  "status": "success",
  "response": {
    "charid": "JD321",
    "name": "Jane A Smith",
    "ssn": "123456789",
    "age": "35",
    "address": "000 No Where Rd"
  }
}
```

{% endtab %}
{% endtabs %}
