An applicant applies to a program at an organization.


Name Type Description Example
href string Hypertext reference to this resource.
pattern: /api/v1/user_identities/\d+/programs
programs/id integer Unique identifier of this program. 42023191739237
programs/name string Human-readable name of this program. Likely to be repeated between organizations. "Potions"
programs/organization_name nullable string Human-readable name of organization whose program this is. "Hogwarts School of Witchcraft and Wizardry"

Program List

List existing programs.

GET /api/v1/user_identities/:user_identity_id/programs

Curl Example

$ curl -n \
  -H "x-api-key: 0123456789abcdef0123456789abcdef"

Response Example

HTTP/1.1 200 OK
  "href": "/api/v1/user_identities/1/programs",
  "programs": [
      "id": 42023191739237,
      "name": "Potions",
      "organization_name": "Hogwarts School of Witchcraft and Wizardry"

Not Found

Response Example

HTTP/1.1 404 Not Found
  "message": "Not Found"

While 404 Not Found is most often associated with resources that don't exist when making a GET request, please note that 404 Not Found is also the response during POST, PUT, and PATCH requests if any resources specified by parameters cannot be found.


Response Example

HTTP/1.1 401 Unauthorized

(Empty response body.)