> ## Documentation Index > Fetch the complete documentation index at: https://hack-club-pin-docs-urls.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # Create a mobile token > Exchange a Hack Club OAuth authorization code, or a signed session token, for a mobile bearer token. Public — no bearer token required. ## OpenAPI ````yaml /openapi.yml post /session openapi: 3.0.3 info: title: Attend API version: v1 description: > REST API for [Attend](https://attend.hackclub.com), Hack Club's event management platform. The API is used by the Attend mobile app and by trusted server-to-server integrations. ## Authentication Almost every endpoint requires a bearer token: ``` Authorization: Bearer ``` Four kinds of token are accepted: - **Mobile token** — issued to a signed-in user by `POST /session`. Sets the current user. May return the response header `X-Token-Refresh-Recommended: true` when the token is nearing expiry; call `POST /session/refresh` to rotate it. - **Global API token** — a superadmin-issued token. Only honoured while its owner is still a global admin. Sets the current user. May be **scoped** when issued, in which case it reaches only the endpoints that accept that scope and returns `403` everywhere else, read-only endpoints included. An unscoped token carries its owner's full access. Scopes are noted on the endpoints that accept them; the only one today is `bans:write`. - **Series API key** — one key for a whole event series, issued from **Series → API Keys** in the dashboard by a series owner. Does **not** set a current user. It acts as an event API key on *every* event in its series, and it is the only credential that can create an event. Scopes do not apply — a series key's reach is its series. See the **Series** section. - **Event API key** — per-event key (`EventApiToken`, or the legacy `Event#api_key`). Does **not** set a current user, so it only works on the subset of endpoints that don't require one (participant `lookup`, `roster`, `create`, and the travel calendar). Missing or invalid credentials return `401 { "error": "Unauthorized" }`. ### What an API key cannot do Neither key kind sets a current user, so endpoints that must attribute work to a person stay closed to both — regardless of how broad the key is. A series key is wider in *reach* (more events), never in *depth*: | Endpoint | Series key | Event key | | --- | --- | --- | | `GET/POST /series/…` | ✅ its own series | ❌ `403` | | `POST /series/{id}/events` | ✅ its own series | ❌ `403` | | Participant `lookup`, `roster`, `create` | ✅ any event in the series | ✅ its own event | | `GET /events/{id}/travel` | ✅ any event in the series | ✅ its own event | | `GET /events/{id}/participants` (full payload) | ❌ `403` | ❌ `403` | | Notes, scans, scan contexts, Slack blasts, NFC badges | ❌ `403` | ❌ `403` | Either key can be revoked without credentials by POSTing its own secret to `POST /tokens/revoke`; Attend emails the key's owner (or, if their account is gone, the series owners) when that happens. ## Conventions - All timestamps are ISO 8601 strings and may be `null` where noted. - Errors use the envelope `{ "error": "" }`. - `:event_id` path segments accept a numeric id or the event slug on the participants endpoints; other endpoints accept the numeric id only. > **Note:** Inbound webhook receivers (Postmark, Help Scout, DocuSeal, > Slack events) also live under `/api/v1` but are called by third parties, > not by API consumers, and are not documented here. servers: - url: https://attend.hackclub.com/api/v1 description: Production - url: http://localhost:3000/api/v1 description: Local development security: - bearerAuth: [] tags: - name: Authentication description: Obtain, refresh, and revoke mobile bearer tokens. - name: Account description: The authenticated user's profile and accessible events. - name: Series description: >- Event series, and the events inside one, addressed with a single series API key. Creating an event lives here — an event has to belong to a series, and only a series key names one unambiguously. - name: Participants description: Participant registrations for an event. - name: Notes description: Staff notes on a participant's registration. - name: Scans description: QR / NFC / manual scans and check-in. - name: Scan Contexts description: The scan stations configured for an event. - name: Travel Calendar description: Chronological participant travel and pickup operations. - name: Slack Blasts description: Broadcast Slack messages to an event's participants. - name: NFC Badges description: Provision and manage participant NFC badges. - name: Push Tokens description: Register device push-notification tokens. - name: Bans description: The app-wide ban list. Global admins only. - name: Travel description: >- Airport and flight lookups. These endpoints authenticate with the web session cookie (Devise), not a bearer token. paths: /session: post: tags: - Authentication summary: Create a mobile token description: >- Exchange a Hack Club OAuth authorization code, or a signed session token, for a mobile bearer token. Public — no bearer token required. requestBody: content: application/json: schema: type: object properties: code: type: string description: Hack Club OAuth authorization code (exchanged server-side). redirect_uri: type: string description: Redirect URI used in the OAuth code exchange. code_verifier: type: string description: PKCE code verifier, if PKCE was used. session_token: type: string description: Signed session token (used when `code` is absent). device_name: type: string description: Human-readable device label, stored on the token. responses: '200': description: Token issued. content: application/json: schema: $ref: '#/components/schemas/SessionResponse' '401': description: Could not resolve a user from the supplied credentials. content: application/json: schema: $ref: '#/components/schemas/Error' security: [] components: schemas: SessionResponse: type: object properties: token: type: string example: mt_live_abc123 expires_at: type: string format: date-time user: type: object properties: id: type: integer example: 42 name: type: string example: Leo email: type: string format: email global_admin: type: boolean events: type: array items: $ref: '#/components/schemas/Event' Error: type: object properties: error: type: string example: Unauthorized Event: type: object properties: id: type: integer example: 7 name: type: string example: The Great Hackathon slug: type: string example: the-great-hackathon starts_at: type: string format: date-time nullable: true ends_at: type: string format: date-time nullable: true timezone: type: string example: America/New_York location_city: type: string nullable: true example: New York logo_url: type: string nullable: true banner_url: type: string nullable: true securitySchemes: bearerAuth: type: http scheme: bearer description: >- Mobile token, global API token, series API key, or event API key. See Authentication above for which endpoints each one reaches. ````