Coaches
Coaches Documentation
Coach [LIST]
Coach [LIST]
Request
Endpoint
GET /api/v2/account_lists/1f6d99c1-90ea-4345-a151-a289c9e59a09/coaches
Content-Type: application/vnd.api+json
Body
Response
Headers
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
Body
{
"data": [
{
"id": "036f23f3-46f7-4dac-955e-6d4ada084b60",
"type": "users",
"attributes": {
"created_at": "2021-11-23T14:37:44Z",
"first_name": "Wes",
"last_name": "Nolan",
"updated_at": "2021-11-23T14:37:44Z",
"updated_in_db_at": "2021-11-23T14:37:44Z"
}
},
{
"id": "168cd910-4421-4471-a66a-7dd059e73645",
"type": "users",
"attributes": {
"created_at": "2021-11-23T14:37:44Z",
"first_name": "Trevor",
"last_name": "Mitchell",
"updated_at": "2021-11-23T14:37:44Z",
"updated_in_db_at": "2021-11-23T14:37:44Z"
}
}
],
"meta": {
"pagination": {
"page": 1,
"per_page": 25,
"total_count": 2,
"total_pages": 1
},
"sort": null,
"filter": {
}
}
}
Fields
data
Type
[User]
Description An array of User Objects
Coach [GET]
Coach [GET]
Request
Endpoint
GET /api/v2/account_lists/2091d6ad-6393-4e50-8a6f-d272b5876b04/coaches/92c3f193-9660-49e1-b76a-fd75687e83f6
Content-Type: application/vnd.api+json
Body
Response
Headers
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
Body
{
"data": {
"id": "92c3f193-9660-49e1-b76a-fd75687e83f6",
"type": "users",
"attributes": {
"created_at": "2021-11-23T14:37:44Z",
"first_name": "Zane",
"last_name": "Yost",
"updated_at": "2021-11-23T14:37:44Z",
"updated_in_db_at": "2021-11-23T14:37:44Z"
}
}
}
Fields
Attributes
created_at
Type
date
Description The timestamp of when this resource was created
first_name
Type
string
Description First Name
last_name
Type
string
Description Last Name
updated_at
Type
date
Description The timestamp of when this resource was last updated
updated_in_db_at
Type
date
Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.
Coach [DELETE]
Coach [DELETE]
Request
Endpoint
DELETE /api/v2/account_lists/309176ba-e5c1-4681-b4bc-f1e5c2d3bfdd/coaches/c2c740ca-e2c9-49dd-8ff4-412a655c5b1a
Content-Type: application/vnd.api+json
Body
Response
Headers
204 No Content
Body
Last updated