Counselors API

Get my profile

This endpoint is only available to counselors

Get the currently logged in counselor’s info.

GET /me

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 counselors

This endpoint is only available to counselors

List all counselors visible to the currently logged-in counselor.

GET /counselors

Parameters

sort
created_at, updated_at, first_name, last_name, default: last_name.
direction
asc or desc, 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": "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"
  }
]

Get a single counselor

This endpoint is only available to counselors

Get a single counselor with their ID.

GET /counselors/:counselor_id

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"
}

Create a new counselor

This endpoint is only available to counselors

Create a new counselor as a “child” counselor of the currently logged-in counselor.

POST /counselors

Response

Status: 201 Created
location: https://tapability.org/api/v1/counselors/ac300f35-61a0-49e4-85c2-5b283d876b31
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"
}

Edit a counselor

This endpoint is only available to counselors

Edit the profile attributes of a given counselor.

PATCH /counselors/:counselor_id

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"
}

Delete a counselor

This endpoint is only available to counselors

Delete the provided counselor.

DELETE /counselors/:counselor_id

Response

Status: 204 No Content
X-RateLimit-Limit: 5000
X-RateLimit-Remaining: 4999