Quickstart

This guide uses a personal API key to list published public raffles.

Create an API key

Create a personal API key from CollabOS developer settings.Personal keys start with co_u_. Workspace keys start with co_w_.Copy the plaintext key when it is created. CollabOS does not return the full key again later.

Choose the right scope

For this example, the key needs raffles:read.See Scopes for the full list.

Store the key in your environment

export COLLABOS_API_KEY="co_u_..."

Keep API keys on a trusted server. Do not expose them in browser bundles or public source code.

Make your first request

curl "https://api.collabos.app/api/v1/raffles?limit=10" \
  -H "Authorization: Bearer $COLLABOS_API_KEY"

You can also authenticate with X-API-Key:

curl "https://api.collabos.app/api/v1/raffles?limit=10" \
  -H "X-API-Key: $COLLABOS_API_KEY"

Read the response

{
  "data": [
    {
      "id": "raffle_...",
      "slug": "example-raffle",
      "title": "Example raffle",
      "status": "OPEN"
    }
  ],
  "pagination": {
    "nextCursor": null,
    "hasMore": false
  }
}

When hasMore is true, send nextCursor as the next request’s cursor value. Treat cursors as opaque strings.

Next steps

Authentication

Understand key types and authentication headers.

Pagination

Continue through larger result sets safely.

Webhooks

Receive changes instead of polling.

Get started

Using the API

Developer settings

Webhooks

Next steps

Authentication

Pagination

Webhooks

​Next steps

Authentication

Pagination

Webhooks

Next steps