Kanka logo Kanka

Characters


All Characters

You can get a list of all the characters of a campaign by using the following endpoint.

{warning} Don't forget that all endpoints documented here need to be prefixed with api/1.0/campaigns/{campaign.id}/.

Method Endpoint Headers
GET/HEAD characters Default

Results

{
    "data": [
        {
            "id": 1,
            "name": "Jonathan Green",
            "entry": "\n<p>Lorem Ipsum.</p>\n",
            "image": "{path}",
            "image_full": "{url}",
            "image_thumb": "{url}",
            "is_private": true,
            "entity_id": 4,
            "tags": [],
            "created_at": {
                "date": "2017-10-31 10:55:08.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            },
            "created_by": 1,
            "updated_at": {
                "date": "2018-09-20 09:18:58.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            },
            "updated_by": 1,
            "location_id": 4,
            "title": null,
            "age": "39",
            "sex": "Male",
            "race_id": 3,
            "type": null,
            "family_id": 34,
            "is_dead": true,
            "traits": [
                {
                    "id": 33,
                    "name": "Goals",
                    "entry": "Become a Paladin.",
                    "section": "personality",
                    "is_private": false,
                    "default_order": 0
                }
            ]
        }
    ]
}

Character

To get the details of a single character, use the following endpoint.

Method Endpoint Headers
GET/HEAD characters/{character.id} Default

Results

{
    "data": {
        "id": 1,
        "name": "Jonathan Green",
        "entry": "\n<p>Lorem Ipsum.</p>\n",
        "image": "{path}",
        "image_full": "{url}",
        "image_thumb": "{url}",
        "has_custom_image": true,
        "is_private": true,
        "entity_id": 4,
        "tags": [],
        "created_at": {
            "date": "2017-10-31 10:55:08.000000",
            "timezone_type": 3,
            "timezone": "UTC"
        },
        "created_by": 1,
        "updated_at": {
            "date": "2018-09-20 09:18:58.000000",
            "timezone_type": 3,
            "timezone": "UTC"
        },
        "updated_by": 1,
        "location_id": 4,
        "title": null,
        "age": "39",
        "sex": "Male",
        "race_id": 3,
        "type": null,
        "family_id": 34,
        "is_dead": true,
        "traits": [
            {
                "id": 33,
                "name": "Goals",
                "entry": "Become a Paladin.",
                "section": "personality",
                "is_private": false,
                "default_order": 0
            }
        ]
    }

}

Create a Character

To create a character, use the following endpoint.

Method Endpoint Headers
POST characters Default

Body

Parameter Type Detail
name string (Required) Name of the character
title string Title of the character
age string Age of the character
sex string Gender of the character
type string Type of the character
family_id integer Family id
location_id integer Location id
race_id integer Race id
tags array Array of tag ids
is_dead boolean If the character is dead
is_private boolean If the character is only visible to admin members of the campaign
image stream Stream to file uploaded to the character
image_url string URL to a picture to be used for the character
personality_name array An array representing the name of personality traits. For exemple ["Goals", "Fears"]
personality_entry array An array representing the values of personality traits. For exemple ["To become a King", "Quiet places"]
appearance_name array An array representing the name of appearance traits. For exemple ["Hair", "Eyes"]
appearance_entry array An array representing the values of appearance traits. For exemple ["Curly black", "Light Green"]

Results

{success} Code 200 with JSON body of the new character.

Update a Character

To update a character, use the following endpoint.

Method Endpoint Headers
PUT/PATCH characters/{character.id} Default

Body

The same body parameters are available as for when creating a character.

Results

{success} Code 200 with JSON body of the updated character.

Delete a Character

To delete a character, use the following endpoint.

Method Endpoint Headers
DELETE characters/{character.id} Default

Results

{success} Code 200 with JSON.