> ## 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 badge progress and awards > One record per young person per badge (and stage), from planned to awarded, for the group’s current members. A record belongs to the young person, so it is listed whichever group awarded it. Adult volunteers’ awards are not included. ## OpenAPI ````yaml /api-reference/openapi.json get /badges 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: /badges: get: tags: - Badges summary: List badge progress and awards description: >- One record per young person per badge (and stage), from planned to awarded, for the group’s current members. A record belongs to the young person, so it is listed whichever group awarded it. Adult volunteers’ awards are not included. operationId: listBadgeRecords 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: Only records at this stage, for example `awarded`. schema: type: string enum: - not_completed - planned - in_progress - completed - awarded - name: memberId in: query required: false description: Only this young person’s records. schema: 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)$ responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/V1BadgeRecordPage' 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: - badges:read components: schemas: V1BadgeRecordPage: type: object properties: data: type: array items: $ref: '#/components/schemas/V1BadgeRecord' 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 V1BadgeRecord: 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)$ member: $ref: '#/components/schemas/V1MemberRef' badge: $ref: '#/components/schemas/V1Badge' level: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: For a staged badge, the stage. Null otherwise. status: type: string enum: - not_completed - planned - in_progress - completed - awarded startedAt: 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' completedAt: 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' awardedAt: 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' required: - id - member - badge - level - status - startedAt - completedAt - awardedAt V1MemberRef: 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)$ firstName: type: string lastName: type: string required: - id - firstName - lastName V1Badge: 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 category: type: string enum: - challenge_awards - activity_badges - staged_activity_badges - core_badges type: type: string enum: - activity - challenge_award - top_award - staged_activity - joining_in - leadership - moving_on - youshape - earth_tribe - patrol required: - id - name - category - type 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. ````