Skip to main content
GET
List badge progress and awards

Authorizations

Authorization
string
header
required

A group API key, sent as Authorization: Bearer sw_live_…. Keys from staging and the demo start sw_test_ instead. A group admin creates keys in Settings → Integrations → API keys.

Query Parameters

cursor
string

Opaque. Pass the nextCursor of the previous page, with the same filters, to get the next one. Do not build or parse it.

Required string length: 1 - 512
limit
integer
default:50

Page size, 1 to 200. Defaults to 50.

Required range: 1 <= x <= 200
status
enum<string>

Only records at this stage, for example awarded.

Available options:
not_completed,
planned,
in_progress,
completed,
awarded
memberId
string<uuid>

Only this young person’s records.

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)$
updatedSince
string<date-time>

Only records that changed at or after this time. Pass the previous walk’s nextUpdatedSince. Records that were deleted or left the list are not reported: run a full read, without updatedSince, at least once a week.

Response

OK

data
object[]
required
nextCursor
string | null
required

Pass as ?cursor= for the next page. Null on the last. Opaque.

nextUpdatedSince
string<date-time>

Only with updatedSince. Pass it as updatedSince on your next sync. It is a little before this walk began, so a record changed while you were paging is read again next time, never missed.