> For the complete documentation index, see [llms.txt](https://docs.ushahidi.com/v3-ushahidi-platform-rest-api-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ushahidi.com/v3-ushahidi-platform-rest-api-documentation/v3/hxl.md).

# HXL

{% openapi src="/files/DFxnj85ZsASPYXzkPAko" path="/api/v3/hxl" method="get" %}
[UshahidiV3.json](https://content.gitbook.com/content/tXIYKGMTeHub5C8O9fER/blobs/TC8KXqdBoVrA1ZGmo9Kk/UshahidiV3.json)
{% endopenapi %}

{% openapi src="/files/DFxnj85ZsASPYXzkPAko" path="/api/v3/hxl/metadata" method="get" %}
[UshahidiV3.json](https://content.gitbook.com/content/tXIYKGMTeHub5C8O9fER/blobs/TC8KXqdBoVrA1ZGmo9Kk/UshahidiV3.json)
{% endopenapi %}

## add hxl metadata

<mark style="color:green;">`POST`</mark> `https://ushahididocs.api.ushahidi.io/api/v3/hxl/metadata`

#### Request Body

| Name               | Type    | Description                                                        |
| ------------------ | ------- | ------------------------------------------------------------------ |
| organisation\_name | String  | The organisation name                                              |
| organisation\_id   | String  | The organisations identifier                                       |
| license\_id        | Integer | Lincense identifier                                                |
| dataset\_title     | String  | The title of the dataset                                           |
| private            | Boolean | Set True if you want metadata to be private and false if you don't |
| user\_id           | Integer | The user identifier                                                |
| source             | String  | Metadata source                                                    |

{% tabs %}
{% tab title="200: OK " %}

```javascript
{
    "id": 5,
    "url": "http://localhost:8000/api/v3/hxl_meta_data/5",
    "user": {
        "id": 2,
        "url": "http://localhost:8000/api/v3/users/2"
    },
    "private": true,
    "dataset_title": "ushahidi-dataset",
    "license_id": 1,
    "organisation_id": "ushahidi-org-id",
    "organisation_name": "ushahidi",
    "source": "other",
    "created": "1970-01-01T00:00:00+00:00",
    "updated": null,
    "allowed_privileges": [
        "read",
        "create",
        "update",
        "delete",
        "search"
    ]
}
```

{% endtab %}
{% endtabs %}

{% openapi src="/files/DFxnj85ZsASPYXzkPAko" path="/api/v3/hxl/licenses" method="get" %}
[UshahidiV3.json](https://content.gitbook.com/content/tXIYKGMTeHub5C8O9fER/blobs/TC8KXqdBoVrA1ZGmo9Kk/UshahidiV3.json)
{% endopenapi %}

{% openapi src="/files/DFxnj85ZsASPYXzkPAko" path="/api/v3/hxl/tags" method="get" %}
[UshahidiV3.json](https://content.gitbook.com/content/tXIYKGMTeHub5C8O9fER/blobs/TC8KXqdBoVrA1ZGmo9Kk/UshahidiV3.json)
{% endopenapi %}

{% openapi src="/files/DFxnj85ZsASPYXzkPAko" path="/api/v3/hxl/organisations" method="get" %}
[UshahidiV3.json](https://content.gitbook.com/content/tXIYKGMTeHub5C8O9fER/blobs/TC8KXqdBoVrA1ZGmo9Kk/UshahidiV3.json)
{% endopenapi %}