> ## Documentation Index > Fetch the complete documentation index at: https://developers.scoutworks.app/llms.txt > Use this file to discover all available pages before exploring further. # List events > Meetings, trips and camps, soonest first. Leader admin meetings and leaders-only events are not included. To keep a calendar in sync, bound the list with `from` and `to`: an event rescheduled while you page can otherwise move across a page boundary. ## OpenAPI ````yaml /api-reference/openapi.json get /events openapi: 3.1.0 info: title: Scoutworks public API version: 1.1.0 description: >- Read your Scout group’s data from your own tools: spreadsheets, scripts, Zapier or n8n. Every request is scoped to the group that owns the key. **Authentication.** Send a group API key as a Bearer token. Keys are created by a group admin and shown once. **Scopes.** Each operation names the scope it needs. Area scopes (`members:read`, `events:read`, `badges:read`, `waiting-list:read`) open an area; a `.contacts` scope adds dates of birth and parent details to that area’s responses. Fields a key may not see are left out, not sent as null. Health, bank details and free-text notes are never available. **Pagination.** Lists return `{ data, nextCursor }`. Pass `nextCursor` back as `?cursor=`, with the same filters, until it is null. `limit` is 1 to 200. **Errors.** Every error is `{ error: { code, message } }`. Branch on `code`; `message` is for people and may change. **Compatibility.** We aim to change v1 only by addition: new endpoints, new optional parameters, new response fields and new enum values. Ignore fields you do not know and treat an unknown enum value as “other”. We will try to warn you before a breaking change, but one can still happen without notice, so check responses and fail loudly on an error. Changes are listed in the changelog at https://developers.scoutworks.app/changelog. **Rate limits.** 120 requests a minute per key. `RateLimit-*` headers report what is left. servers: - url: https://api.scoutworks.app/api/v1 description: Live - url: https://api-demo.scoutworks.app/api/v1 description: Demo (sample data, reset weekly) security: - bearerAuth: [] tags: - name: Keys description: Check a key and see what it can reach. - name: Members description: Young people in the group. - name: Events description: Meetings, trips and camps, and who is going. - name: Badges description: Badge progress and awards. - name: Waiting list description: Applications waiting for a place. paths: /events: get: tags: - Events summary: List events description: >- Meetings, trips and camps, soonest first. Leader admin meetings and leaders-only events are not included. To keep a calendar in sync, bound the list with `from` and `to`: an event rescheduled while you page can otherwise move across a page boundary. operationId: listEvents parameters: - name: cursor in: query required: false description: >- Opaque. Pass the `nextCursor` of the previous page, with the same filters, to get the next one. Do not build or parse it. schema: type: string minLength: 1 maxLength: 512 - name: limit in: query required: false description: Page size, 1 to 200. Defaults to 50. schema: default: 50 type: integer minimum: 1 maximum: 200 - name: status in: query required: false description: Defaults to `published`. schema: default: published type: string enum: - draft - published - archived - name: from in: query required: false description: Only events that start at or after this time. schema: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$ - name: to in: query required: false description: Only events that start before this time. After `from`. schema: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$ responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/V1EventPage' headers: RateLimit-Limit: description: Requests allowed in the current window. schema: type: integer RateLimit-Remaining: description: Requests left in the current window. schema: type: integer RateLimit-Reset: description: Seconds until the window resets. schema: type: integer '400': description: A query parameter or cursor is not acceptable (`invalid_request`). headers: RateLimit-Limit: description: Requests allowed in the current window. schema: type: integer RateLimit-Remaining: description: Requests left in the current window. schema: type: integer RateLimit-Reset: description: Seconds until the window resets. schema: type: integer content: application/json: schema: $ref: '#/components/schemas/V1Error' '401': description: >- No API key, or one that is unknown, revoked or expired (`invalid_api_key`). headers: RateLimit-Limit: description: Requests allowed in the current window. schema: type: integer RateLimit-Remaining: description: Requests left in the current window. schema: type: integer RateLimit-Reset: description: Seconds until the window resets. schema: type: integer content: application/json: schema: $ref: '#/components/schemas/V1Error' '403': description: The key lacks the scope this operation needs (`insufficient_scope`). headers: RateLimit-Limit: description: Requests allowed in the current window. schema: type: integer RateLimit-Remaining: description: Requests left in the current window. schema: type: integer RateLimit-Reset: description: Seconds until the window resets. schema: type: integer content: application/json: schema: $ref: '#/components/schemas/V1Error' '429': description: Too many requests; wait `retryAfter` seconds (`rate_limited`). headers: RateLimit-Limit: description: Requests allowed in the current window. schema: type: integer RateLimit-Remaining: description: Requests left in the current window. schema: type: integer RateLimit-Reset: description: Seconds until the window resets. schema: type: integer Retry-After: description: Seconds to wait before trying again. schema: type: integer content: application/json: schema: $ref: '#/components/schemas/V1Error' '500': description: Our fault; quote `errorRef` to support (`internal_error`). headers: RateLimit-Limit: description: Requests allowed in the current window. schema: type: integer RateLimit-Remaining: description: Requests left in the current window. schema: type: integer RateLimit-Reset: description: Seconds until the window resets. schema: type: integer content: application/json: schema: $ref: '#/components/schemas/V1Error' security: - bearerAuth: - events:read components: schemas: V1EventPage: type: object properties: data: type: array items: $ref: '#/components/schemas/V1Event' nextCursor: anyOf: - type: string - type: 'null' description: Pass as `?cursor=` for the next page. Null on the last. Opaque. required: - data - nextCursor V1Error: type: object properties: error: type: object properties: code: type: string enum: - invalid_api_key - insufficient_scope - invalid_request - not_found - rate_limited - internal_error message: type: string required: - code - message errorRef: description: 'On a 500: a reference to quote to Scoutworks support.' type: string retryAfter: description: 'On a 429: seconds to wait before trying again.' type: integer minimum: -9007199254740991 maximum: 9007199254740991 required: - error V1Event: type: object properties: id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ title: type: string type: type: string enum: - programme_meeting - activity_trip - camp_residential status: type: string enum: - draft - published - archived startsAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ description: A UTC timestamp, ISO 8601. endsAt: anyOf: - type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ description: A UTC timestamp, ISO 8601. - type: 'null' location: anyOf: - type: string - type: 'null' hosted: type: boolean description: >- True when this group runs the event. False for a joint event run by another group that this group has accepted a place on. sections: type: array items: $ref: '#/components/schemas/V1NamedRef' description: >- This group’s sections the event is for. On a hosted event, empty means the whole group; a joint event lists none. rsvpRequired: type: boolean rsvpDeadline: anyOf: - type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ description: A UTC timestamp, ISO 8601. - type: 'null' capacity: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' attendeeCount: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: This group’s members who said yes or were marked present. required: - id - title - type - status - startsAt - endsAt - location - hosted - sections - rsvpRequired - rsvpDeadline - capacity - attendeeCount V1NamedRef: type: object properties: id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ name: type: string required: - id - name securitySchemes: bearerAuth: type: http scheme: bearer description: >- A group API key, sent as `Authorization: Bearer sw_live_…`. A group admin creates keys in Settings → Integrations → API keys. ````