Getting Started

Generate an API key, choose its access level and make your first request to the Cakewalk Open API.

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 for what each level can do.

First Request Example

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

Response:

{
  "data": [
{
            "id": "6c95576d-e21e-4b4b-a15f-2a3b507f44c3",
            "name": "Alice Smith",
            "email": "[e-mail]",
            "statusId": 2,
            "statusName": "Invited"
        },
        {
            "id": "0a46407a-2d05-4518-add2-6a45185ed99e",
            "name": "Tom Johnson",
            "email": "[e-mail]",
            "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