> For the complete documentation index, see [llms.txt](https://rest-api-federation.symphony.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://rest-api-federation.symphony.com/readme/getting-started.md).

# Getting started

{% hint style="warning" %}
Always use the ![](/files/m7sG1yMt1hKM9aixTWhz) **Copy** icon in the example field when copying examples. Manual copy and paste is known to cause data format errors.
{% endhint %}

## Domain name

{% hint style="info" %}
For all the APIs, CONNECT-DOMAIN refers to the domain name for the WECHAT or WHATSAPP or SMS or SMS-DIRECT or LINE platforms.
{% endhint %}

* Production CONNECT-DOMAIN: `https://connect.symphony.com/admin`
* Test CONNECT-DOMAIN: `https://connect.uat.symphony.com/admin`

#### **Example: Request to get the list of available entitlements**

```bash
curl -X GET "https://connect.symphony.com/admin/api/v2/customer/entitlements"
```

{% hint style="info" %}
**Note:** Headers have been omitted in this example.
{% endhint %}

## Multi-company contacts

For Multi-company-contacts, the contacts must be from the same network, for example, all from WeChat or all from WhatsApp. Cross-network rooms are not authorized.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://rest-api-federation.symphony.com/readme/getting-started.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.
