# Join Community

{% hint style="warning" %}
This API endpoint is not available to the public and exists for internal documentation only for the CMS program.
{% endhint %}

## Join Community

<mark style="color:green;">`POST`</mark> `https://api.sonorancad.com/sso/community`

This endpoint allows you to retrieve your community's server configuration. This contains valuable Live Map configuration data and can be used to ensure correct Live Map configs.

#### Request Body

| Name                                          | Type   | Description                                       |
| --------------------------------------------- | ------ | ------------------------------------------------- |
| id<mark style="color:red;">\*</mark>          | string | Your community's ID                               |
| key<mark style="color:red;">\*</mark>         | string | Your community's API Key                          |
| type<mark style="color:red;">\*</mark>        | string | JOIN\_COMMUNITY                                   |
| data<mark style="color:red;">\*</mark>        | array  | Array of request objects                          |
| internalKey<mark style="color:red;">\*</mark> | N/A    | Key for internal use only, not open to the public |

{% tabs %}
{% tab title="200 A successful call will be met with the following response:" %}

```
```

{% endtab %}

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

```http
INVALID REQUEST TYPE
INVALID COMMUNITY ID
API IS NOT ENABLED FOR THIS COMMUNITY
INVALID API KEY
```

{% endtab %}
{% endtabs %}

```javascript
{
    "id": "YOUR_COMMUNITY_ID",
    "key": "YOUR_API_KEY",
    "internalKey": "" // Not disclosed to public
    "type": "JOIN_COMMUNITY",
    "data": [
        {
            "account": "000-000-000-000" // Account UUID
        }
    ]
}
```


---

# 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/cad/api-integration/api-endpoints/general/join-community.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.
