# Get Form Lock Status

## Get Form Lock Status

<mark style="color:green;">`POST`</mark> `https://api.sonorancms.com/forms/get_lock_status`

Get the specific form template lock status

#### Request Body

| Name                                   | Type   | Description              |
| -------------------------------------- | ------ | ------------------------ |
| id<mark style="color:red;">\*</mark>   | string | Community ID             |
| key<mark style="color:red;">\*</mark>  | string | API Key                  |
| type<mark style="color:red;">\*</mark> | string | GET\_FORM\_LOCK\_STATUS  |
| data<mark style="color:red;">\*</mark> | array  | Array of request objects |

{% tabs %}
{% tab title="200: OK The following 200 response texts may be sent in response:" %}
**Locked**

```javascript
true
```

**Unlocked**

```javascript
false
```

{% endtab %}

{% tab title="400: Bad Request The following 400 errors may be sent in response:" %}

```javascript
INVALID API KEY
INVALID COMMUNITY ID
INVALID_TEMPLATE_ID
```

{% endtab %}
{% endtabs %}

```json
{
    "id": "YOUR_COMMUNITY_ID",
    "key": "YOUR_API_KEY",
    "type": "GET_FORM_LOCK_STATUS",
    "data": [
        {
            "templateId": 1,
        }
    ]
}
```

### Template ID

The `templateId` number can be taken from the form editor's URL when editing a form template.

<figure><img src="/files/70mMPFVvYc1M2Ln3XR9e" alt="" width="375"><figcaption></figcaption></figure>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.sonoransoftware.com/cms/developer-api-documentation/api-integration/api-endpoints/forms/get-form-lock-status.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.