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

# Getting Started

### **Prerequisites**

* A Cakewalk account
* Admin privileges to generate API keys
* Access to the developer settings section

When you generate a key, you choose its access level: read and write, or read only. See [Authentication](/docs/open-api-and-mcp/authentication.md) for what each level can do.

### First Request Example

```http
GET /api/v1/users
Host: open-api.getcakewalk.io
X-API-KEY: api key
X-API-SECRET: api secret
```

### **Response:**

```json
{
  "data": [
{
            "id": "6c95576d-e21e-4b4b-a15f-2a3b507f44c3",
            "name": "Alice Smith",
            "email": "alice.smith@cakeacme.com",
            "statusId": 2,
            "statusName": "Invited"
        },
        {
            "id": "0a46407a-2d05-4518-add2-6a45185ed99e",
            "name": "Tom Johnson",
            "email": "tom.johnson@cakeacme.cocm",
            "statusId": 2,
            "statusName": "Invited"
        }

  ],
  "links": {

        "self": "/api/v1/OpenApiBFF/Users",
        "next": "/api/v1/OpenApiBFF/Users?cursor=cGFnZU51bWJlcj0xJnBhZ2VTaXplPTEwMA=="

  }
}
]
```

### Error Handling

Standard HTTP status codes are used:

* `200 OK`: Successful request
* `401 Unauthorized`: Invalid or missing API key
* `403 Forbidden`: A read only key tried to call an endpoint that modifies data
* `404 Not Found`: Resource doesn't exist
* `500 Internal Server Error`: Server-side failure


---

# 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://www.cakewalk.security/docs/open-api-and-mcp/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.