Organisations


All Organisations

You can get a list of all the organisations 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 organisations Default

Results

{
    "data": [
        {
            "id": 1,
            "name": "Tiamat Cultists",
            "entry": "\n<p>Lorem Ipsum.</p>\n",
            "image": "{path}",
            "image_full": "{url}",
            "image_thumb": "{url}",
            "has_custom_image": false,
            "is_private": true,
            "entity_id": 5,
            "tags": [],
            "created_at":  "2019-01-30T00:01:44.000000Z",
            "created_by": 1,
            "updated_at":  "2019-08-29T13:48:54.000000Z",
            "updated_by": 1,
            "location_id": 4,
            "organisation_id": 4,
            "type": "Kingdom",
            "members": []
        }
    ]
}

Filters

The list of returned organisations can be filtered. The available filters are available here: API filters.

Organisation

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

Method Endpoint Headers
GET/HEAD organisations/{organisation.id} Default

Results

{
    "data": {
        "id": 1,
        "name": "Tiamat Cultists",
        "entry": "\n<p>Lorem Ipsum.</p>\n",
        "image": "{path}",
        "image_full": "{url}",
        "image_thumb": "{url}",
        "has_custom_image": false,
        "is_private": true,
        "entity_id": 5,
        "tags": [],
        "created_at":  "2019-01-30T00:01:44.000000Z",
        "created_by": 1,
        "updated_at":  "2019-08-29T13:48:54.000000Z",
        "updated_by": 1,
        "location_id": 4,
        "organisation_id": 4,
        "type": "Kingdom",
        "members": []
    }

}

Organisation Members

To get the members of an organisation, use the following endpoint.

Method Endpoint Headers
GET/HEAD organisations/{organisation.id}/organisation_members Default

Results

{
    "data": {
        "character_id": 11,
        "created_at":  "2019-01-30T00:01:44.000000Z",
        "created_by": 1,
        "id": 6,
        "is_private": false,
        "organisation_id": 1,
        "role": "Leader",
        "updated_at":  "2019-08-29T13:48:54.000000Z",
        "updated_by": 1
    }
}

{info} Adding (POST), Updating (PUT, PATCH) and Deleting (DELETE) a member from an organisation can also be done using the same patterns as for other endpoints.

Create an organisation

To create an organisation, use the following endpoint.

Method Endpoint Headers
POST organisations Default

Body

Parameter Type Detail
name string (Required) Name of the organisation
entry string The html description of the organisation
type string Type of organisation
organisation_id integer The parent organisation
location_id integer The organisation's location
tags array Array of tag ids
is_private boolean If the organisation is only visible to admin members of the campaign
image_url string URL to a picture to be used for the organisation

Results

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

Update an organisation

To update an organisation, use the following endpoint.

Method Endpoint Headers
PUT/PATCH organisations/{organisation.id} Default

Body

The same body parameters are available as for when creating an organisation.

Results

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

Delete an organisation

To delete an organisation, use the following endpoint.

Method Endpoint Headers
DELETE organisations/{organisation.id} Default

Results

{success} Code 200 with JSON.