# Forms

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

## add form

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

#### Request Body

| Name                  | Type    | Description                                                             |
| --------------------- | ------- | ----------------------------------------------------------------------- |
| type                  | String  | Form type                                                               |
| parent\_id            | String  | The user's parent identifier                                            |
| hide\_time            | String  | Set True to hide the time and Flase to  make the time visible           |
| color                 | String  | Form color                                                              |
| hide\_location        | String  | Set True to hide the location and Flase to make the location visible    |
| updated               | String  |                                                                         |
| require\_approval     | String  | Set True to require form approval and Flase to not                      |
| targeted\_survey      | String  | Set True to enable targeted survey and false to disable targeted survey |
| disabled              | Boolean | Set True to disable the form and false to enable the form               |
| everyone\_can\_create | String  | Set True to allow everyone to create form and False to not              |
| description           | String  | Form description                                                        |
| name                  | String  | Form name                                                               |
| hide\_author          | Boolean | Set True to hide the author and Flase to  make the author visible       |

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

```javascript
{
    "id": 11,
    "url": "http://localhost:8000/api/v3/forms/11",
    "parent_id": null,
    "name": "Test Form",
    "description": "Testing form",
    "color": null,
    "type": "report",
    "disabled": false,
    "created": "2022-11-03T11:24:37+00:00",
    "updated": null,
    "hide_author": false,
    "hide_time": false,
    "hide_location": false,
    "require_approval": false,
    "everyone_can_create": true,
    "targeted_survey": false,
    "can_create": [],
    "tags": [],
    "allowed_privileges": [
        "read",
        "create",
        "update",
        "delete",
        "search"
    ]
}
```

{% endtab %}
{% endtabs %}

## add form

<mark style="color:orange;">`PUT`</mark> `https://ushahididocs.api.ushahidi.io/api/v3/forms/9`

#### Request Body

| Name                  | Type    | Description                                                             |
| --------------------- | ------- | ----------------------------------------------------------------------- |
| type                  | String  | Form type                                                               |
| parent\_id            | String  | The user's parent identifier                                            |
| hide\_time            | String  | Set True to hide the time and Flase to  make the time visible           |
| color                 | String  | Form color                                                              |
| hide\_location        | String  | Set True to hide the location and Flase to make the location visible    |
| updated               | String  |                                                                         |
| require\_approval     | String  | Set True to require form approval and Flase to not                      |
| targeted\_survey      | String  | Set True to enable targeted survey and false to disable targeted survey |
| disabled              | Boolean | Set True to disable the form and false to enable the form               |
| everyone\_can\_create | String  | Set True to allow everyone to create form and False to not              |
| description           | String  | Form description                                                        |
| name                  | String  | Form name                                                               |
| hide\_author          | Boolean | Set True to hide the author and Flase to  make the author visible       |

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

```javascript
{
    "id": 11,
    "url": "http://localhost:8000/api/v3/forms/11",
    "parent_id": null,
    "name": "Test Form",
    "description": "Testing form",
    "color": null,
    "type": "report",
    "disabled": false,
    "created": "2022-11-03T11:24:37+00:00",
    "updated": null,
    "hide_author": false,
    "hide_time": false,
    "hide_location": false,
    "require_approval": false,
    "everyone_can_create": true,
    "targeted_survey": false,
    "can_create": [],
    "tags": [],
    "allowed_privileges": [
        "read",
        "create",
        "update",
        "delete",
        "search"
    ]
}
```

{% endtab %}
{% endtabs %}

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

{% openapi src="<https://content.gitbook.com/content/tXIYKGMTeHub5C8O9fER/blobs/TC8KXqdBoVrA1ZGmo9Kk/UshahidiV3.json>" path="/api/v3/forms/1" method="delete" %}
[UshahidiV3.json](https://content.gitbook.com/content/tXIYKGMTeHub5C8O9fER/blobs/TC8KXqdBoVrA1ZGmo9Kk/UshahidiV3.json)
{% endopenapi %}

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

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

{% openapi src="<https://content.gitbook.com/content/tXIYKGMTeHub5C8O9fER/blobs/TC8KXqdBoVrA1ZGmo9Kk/UshahidiV3.json>" path="/api/v3/forms/4/stats" method="get" %}
[UshahidiV3.json](https://content.gitbook.com/content/tXIYKGMTeHub5C8O9fER/blobs/TC8KXqdBoVrA1ZGmo9Kk/UshahidiV3.json)
{% endopenapi %}