API ReferenceLists
Retrieve a subscriber list
GET
Fetch one list by id, with the same status-agnostic member_count the collection returns.
Requires the lists:read scope — View your subscriber lists and who is on them.
header
AuthorizationBearer <API Key>API key authentication. Use a sk_* (FULL) or pk_* (SENDING_ONLY) key as the bearer token. Public keys (pk_*) are restricted to the email-send endpoints and the self-serve list subscribe/unsubscribe pair; every other endpoint — event tracking included — answers 403 for them. In scope terms (used by /api/v1/* operations): FULL keys hold every scope; SENDING_ONLY keys hold only emails:send.
id*stringResource id.
Format
uuidThe list
application/json- response
A subscriber list as exposed on the v1 API.
id*stringFormat
uuidname*stringdescription*string|nulldouble_opt_in*booleanconfirmation_template_id*|Format
uuidredirect_url*string|nullmember_count*integerMemberships in ANY status, including PENDING and UNSUBSCRIBED ones.
created_at*stringFormat
date-timeupdated_at*stringFormat
date-timecurl -X GET 'https://api.sendly.now/api/v1/lists/497f6eca-6276-4993-bfeb-53cbbbba6f08'Example Response
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "description": "string", "double_opt_in": true, "confirmation_template_id": "17dc8a7d-cf14-4d56-b0d2-d285cf33f3bb", "redirect_url": "string", "member_count": 0, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z"}