Candidates API
- Get my profile
- Get information about my counselor
- List candidates
- Get a single candidate
- Edit a candidate
- Archive a candidate
- Delete a candidate
Get my profile
This endpoint is only available to candidates
Get the currently logged in candidate’s info
GET /me
Response
Status: 200 OK
X-RateLimit-Limit: 5000
X-RateLimit-Remaining: 4999
{
"id": "eaf3022f-330e-46db-8665-01e0969ff2f7",
"api_url": "https://tapability.org/api/v1/candidates/eaf3022f-330e-46db-8665-01e0969ff2f7",
"archived": false,
"created_at": "2012-12-09T17:58:26Z",
"updated_at": "2012-12-09T17:58:26Z",
"first_name": "Dwight",
"last_name": "Schrute",
"email": "dwight@tapability.org",
"archived_at": null
}
Get information about my counselor
This endpoint is only available to candidates
Get counselor information for the currently logged-in candidate.
GET /me/counselor
Response
Status: 200 OK
X-RateLimit-Limit: 5000
X-RateLimit-Remaining: 4999
{
"id": "ac300f35-61a0-49e4-85c2-5b283d876b31",
"first_name": "Jim",
"last_name": "Halpert",
"email": "jim@tapability.org",
"title": "Vocational Rehab Counselor",
"api_url": "https://tapability.org/api/v1/counselors/ac300f35-61a0-49e4-85c2-5b283d876b31",
"created_at": "2012-12-09T17:58:26Z",
"updated_at": "2012-12-09T17:58:26Z"
}
List candidates
This endpoint is only available to counselors
List all candidates visible to the currently logged-in counselor.
GET /candidates
Parameters
- sort
-
created_at
,updated_at
,first_name
,last_name
, default:last_name
. - direction
-
asc
ordesc
, default:asc
Response
Status: 200 OK
Link: <https://tapability.org/api/v1/resource?page=2>; rel="next",
<https://tapability.org/api/v1/resource?page=5>; rel="last"
X-RateLimit-Limit: 5000
X-RateLimit-Remaining: 4999
[
{
"id": "eaf3022f-330e-46db-8665-01e0969ff2f7",
"api_url": "https://tapability.org/api/v1/candidates/eaf3022f-330e-46db-8665-01e0969ff2f7",
"archived": false,
"created_at": "2012-12-09T17:58:26Z",
"updated_at": "2012-12-09T17:58:26Z"
}
]
Get a single candidate
This endpoint is only available to counselors
Get a single candidate with their ID.
GET /candidates/:candidate_id
Response
Status: 200 OK
X-RateLimit-Limit: 5000
X-RateLimit-Remaining: 4999
{
"id": "eaf3022f-330e-46db-8665-01e0969ff2f7",
"api_url": "https://tapability.org/api/v1/candidates/eaf3022f-330e-46db-8665-01e0969ff2f7",
"archived": false,
"created_at": "2012-12-09T17:58:26Z",
"updated_at": "2012-12-09T17:58:26Z",
"first_name": "Dwight",
"last_name": "Schrute",
"email": "dwight@tapability.org",
"archived_at": null
}
Edit a candidate
This endpoint is only available to counselors
Edit the profile attributes of a given candidate.
PATCH /candidates/:candidate_id
Response
Status: 200 OK
X-RateLimit-Limit: 5000
X-RateLimit-Remaining: 4999
{
"id": "eaf3022f-330e-46db-8665-01e0969ff2f7",
"api_url": "https://tapability.org/api/v1/candidates/eaf3022f-330e-46db-8665-01e0969ff2f7",
"archived": false,
"created_at": "2012-12-09T17:58:26Z",
"updated_at": "2012-12-09T17:58:26Z",
"first_name": "Dwight",
"last_name": "Schrute",
"email": "dwight@tapability.org",
"archived_at": null
}
Archive a candidate
This endpoint is only available to counselors
Archive the provided candidate so they are not listed with current cases.
POST /candidates/:candidate_id/archive
Response
Status: 200 OK
X-RateLimit-Limit: 5000
X-RateLimit-Remaining: 4999
{
"id": "eaf3022f-330e-46db-8665-01e0969ff2f7",
"api_url": "https://tapability.org/api/v1/candidates/eaf3022f-330e-46db-8665-01e0969ff2f7",
"archived": true,
"created_at": "2012-12-09T17:58:26Z",
"updated_at": "2012-12-09T17:58:26Z",
"first_name": "Dwight",
"last_name": "Schrute",
"email": "dwight@tapability.org",
"archived_at": "2012-12-18T21:41:30Z"
}
Delete a candidate
This endpoint is only available to counselors
Delete the provided candidate
DELETE /candidates/:candidate_id
Response
Status: 204 No Content
X-RateLimit-Limit: 5000
X-RateLimit-Remaining: 4999