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

# Getting Started

### About the API

Much like the [BaseCMS API ](https://docs.parameter1.com/basecms-graphql/)the Engagement API can be accessed using GraphQL -- an abstract query language for retrieving data in a standard format, originally developed by the team at Facebook.\
\
[GraphQL Playground](https://github.com/prisma-labs/graphql-playground) can be used as a locally installed API client, or the GraphQL connection can be accessed programmatically in most languages with the use of a [client](https://graphql.org/code/#graphql-clients). For more information about using GraphQL check out the [docs](https://graphql.org/learn/).

{% hint style="info" %}
You'll need the following information to read data from the API:

* An API URL
* A Tenant Key

If you're missing either of these, please reach out to <support@parameter1.com> and we'd be happy to help you out!
{% endhint %}

### Connecting to the API

Your API URL will be in a format similar to that of the [BaseCMS API](https://docs.parameter1.com/basecms-graphql/) however will be in the format like the following: `engagement.<identifier>.base.parameter1.com.` The API must be accessed via HTTP/S.

Requests to the GraphQL API must include the `x-tenant-key` header for the Base instance in question: such as `x-tenant-key: my-base-instance-id`.\
\
Once connected, you can see available query documentation and schema definitions within the GraphQL Playground application (if using it).\
\
For information regarding the available queries and the data they return see the [Querying Data topic](/engagement-api/querying-data/introduction.md). For further information regarding Connecting to the API consult the [Overview](https://docs.parameter1.com/basecms-graphql/connecting-to-the-api#overview) section of BaseCMS GraphQL API documentation.