List the waiting list
curl --request GET \
--url https://api.scoutworks.app/api/v1/waiting-list \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.scoutworks.app/api/v1/waiting-list"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.scoutworks.app/api/v1/waiting-list', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"firstName": "<string>",
"lastName": "<string>",
"targetSection": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"status": "received",
"position": 0,
"appliedAt": "2023-11-07T05:31:56Z",
"targetStartDate": "2023-12-25",
"dateOfBirth": "2023-12-25",
"parent": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"email": "<string>"
}
}
],
"nextCursor": "<string>"
}{
"error": {
"code": "invalid_api_key",
"message": "<string>"
},
"errorRef": "<string>",
"retryAfter": 0
}{
"error": {
"code": "invalid_api_key",
"message": "<string>"
},
"errorRef": "<string>",
"retryAfter": 0
}{
"error": {
"code": "invalid_api_key",
"message": "<string>"
},
"errorRef": "<string>",
"retryAfter": 0
}{
"error": {
"code": "invalid_api_key",
"message": "<string>"
},
"errorRef": "<string>",
"retryAfter": 0
}{
"error": {
"code": "invalid_api_key",
"message": "<string>"
},
"errorRef": "<string>",
"retryAfter": 0
}Waiting list
List the waiting list
Applications, oldest first, with their target section and queue position. With waiting-list.contacts:read too, each entry also carries dateOfBirth and parent.
GET
/
waiting-list
List the waiting list
curl --request GET \
--url https://api.scoutworks.app/api/v1/waiting-list \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.scoutworks.app/api/v1/waiting-list"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.scoutworks.app/api/v1/waiting-list', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"firstName": "<string>",
"lastName": "<string>",
"targetSection": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"status": "received",
"position": 0,
"appliedAt": "2023-11-07T05:31:56Z",
"targetStartDate": "2023-12-25",
"dateOfBirth": "2023-12-25",
"parent": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"email": "<string>"
}
}
],
"nextCursor": "<string>"
}{
"error": {
"code": "invalid_api_key",
"message": "<string>"
},
"errorRef": "<string>",
"retryAfter": 0
}{
"error": {
"code": "invalid_api_key",
"message": "<string>"
},
"errorRef": "<string>",
"retryAfter": 0
}{
"error": {
"code": "invalid_api_key",
"message": "<string>"
},
"errorRef": "<string>",
"retryAfter": 0
}{
"error": {
"code": "invalid_api_key",
"message": "<string>"
},
"errorRef": "<string>",
"retryAfter": 0
}{
"error": {
"code": "invalid_api_key",
"message": "<string>"
},
"errorRef": "<string>",
"retryAfter": 0
}Authorizations
A group API key, sent as Authorization: Bearer sw_live_…. A group admin creates keys in Settings → Integrations → API keys.
Query Parameters
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 - 512Page size, 1 to 200. Defaults to 50.
Required range:
1 <= x <= 200Only applications at this stage, for example offered.
Available options:
received, contacted, offered, accepted, enrolled, expired, declined, deferred, withdrawn, returned Must be one of the group’s sections.
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)$