Coaches

Coaches Documentation

Coach [LIST]

Coach [LIST]

Request

Endpoint

GET /api/v2/account_lists/1945e318-61bf-4721-95da-b47e2e4a6fde/coaches
Content-Type: application/vnd.api+json

Body

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

Body

{
  "data": [
    {
      "id": "aefdaf48-1499-4c5e-8fd9-652f80cf8da6",
      "type": "users",
      "attributes": {
        "created_at": "2022-01-12T17:18:26Z",
        "first_name": "Lucien",
        "last_name": "Champlin",
        "updated_at": "2022-01-12T17:18:26Z",
        "updated_in_db_at": "2022-01-12T17:18:26Z"
      }
    },
    {
      "id": "8a536a64-b65f-45c5-95e9-0bfdd8cf52f3",
      "type": "users",
      "attributes": {
        "created_at": "2022-01-12T17:18:26Z",
        "first_name": "Donte",
        "last_name": "Hickle",
        "updated_at": "2022-01-12T17:18:26Z",
        "updated_in_db_at": "2022-01-12T17:18:26Z"
      }
    }
  ],
  "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/81b05c9f-b3b2-4efa-933d-ca31b5f4fd63/coaches/2623aa74-d47f-4cd4-9b0b-f288ee20961d
Content-Type: application/vnd.api+json

Body

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

Body

{
  "data": {
    "id": "2623aa74-d47f-4cd4-9b0b-f288ee20961d",
    "type": "users",
    "attributes": {
      "created_at": "2022-01-12T17:18:25Z",
      "first_name": "Chance",
      "last_name": "Donnelly",
      "updated_at": "2022-01-12T17:18:25Z",
      "updated_in_db_at": "2022-01-12T17:18:25Z"
    }
  }
}

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/a7d47a16-9e86-4395-94d6-93593a93ec99/coaches/d7d0e4c3-20b5-4f40-bd28-6ca275bc5afe
Content-Type: application/vnd.api+json

Body

Response

Headers

204 No Content

Body