Waitlist Applicants

get

Authorizations

Authorization

AuthorizationstringRequired

API Token based authentication. Use format: Token token="your-api-key"

Query parameters

listing_idstringOptional

Only include applicants for the specified listing

statusstringOptional

Only include applicants for the specified status (waitlist, accepted, declined, or expired)

Responses

200

Listing applicants

application/json

Responseobject

get

/api/v1/applicants

HTTPcURLJavaScriptPython

GET /api/v1/applicants HTTP/1.1
Host: REPLACE_ME
Authorization: YOUR_API_KEY
Accept: */*

200

Listing applicants

{
  "applicants": [
    {
      "id": 1,
      "user": {
        "id": 1,
        "name": "Applicant",
        "email": "[email protected]"
      },
      "listing": {
        "id": 1,
        "title": "Course 1"
      },
      "notified_of_opening_at": null,
      "status": "waitlist",
      "created_at": "2024/01/01 00:00:00 +0000",
      "updated_at": "2024/01/01 00:00:00 +0000"
    }
  ]
}

delete

Authorizations

Authorization

AuthorizationstringRequired

API Token based authentication. Use format: Token token="your-api-key"

Body

application/x-www-form-urlencoded

listing_idintegerRequired

Only delete applicants for the specified listing

canvas_user_idstringOptional

Only delete applicants with the specified canvas user id if specified

Responses

204

Delete applicants

*/*

delete

/api/v1/applicants

HTTPcURLJavaScriptPython

DELETE /api/v1/applicants HTTP/1.1
Host: REPLACE_ME
Authorization: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 40

"listing_id=1&canvas_user_id='text'"

204

Delete applicants

{}

get

Authorizations

Authorization

AuthorizationstringRequired

API Token based authentication. Use format: Token token="your-api-key"

Path parameters

idintegerRequired

Responses

200

Getting a specific applicant record

application/json

get

/api/v1/applicants/{id}

HTTPcURLJavaScriptPython

GET /api/v1/applicants/{id} HTTP/1.1
Host: REPLACE_ME
Authorization: YOUR_API_KEY
Accept: */*

200

Getting a specific applicant record

{
  "applicant": {
    "id": 2,
    "user": {
      "id": 2,
      "name": "Applicant",
      "email": "[email protected]"
    },
    "listing": {
      "id": 2,
      "title": "Course 2"
    },
    "notified_of_opening_at": null,
    "status": "waitlist",
    "created_at": "2024/01/01 00:00:00 +0000",
    "updated_at": "2024/01/01 00:00:00 +0000"
  }
}