> ## Documentation Index
> Fetch the complete documentation index at: https://docs.collabos.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Create an API key and make your first CollabOS request.

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

<Steps>
  <Step title="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.
  </Step>

  <Step title="Choose the right scope">
    For this example, the key needs `raffles:read`.

    See [Scopes](/guides/scopes) for the full list.
  </Step>

  <Step title="Store the key in your environment">
    ```bash theme={null}
    export COLLABOS_API_KEY="co_u_..."
    ```

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

  <Step title="Make your first request">
    ```bash theme={null}
    curl "https://api.collabos.app/api/v1/raffles?limit=10" \
      -H "Authorization: Bearer $COLLABOS_API_KEY"
    ```

    You can also authenticate with `X-API-Key`:

    ```bash theme={null}
    curl "https://api.collabos.app/api/v1/raffles?limit=10" \
      -H "X-API-Key: $COLLABOS_API_KEY"
    ```
  </Step>

  <Step title="Read the response">
    ```json theme={null}
    {
      "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.
  </Step>
</Steps>

## Next steps

<CardGroup cols={3}>
  <Card title="Authentication" href="/guides/authentication" icon="key">Understand key types and authentication headers.</Card>
  <Card title="Pagination" href="/guides/pagination" icon="list">Continue through larger result sets safely.</Card>
  <Card title="Webhooks" href="/webhooks/overview" icon="webhook">Receive changes instead of polling.</Card>
</CardGroup>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.