Programs and Members

Resources and actions to manage programs and their members

Endpoints

List programs

GET https://api.upcoach.com/programs

Returns a list of programs in the organization

Query Parameters

{
  "data": [
    {
      "id": "...",
      "name": "...",
      "created_at": ...
    },
    ...
  ],
  "links": {
    "first": "...",
    "last": "...",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": ...,
    "from": ...,
    "last_page": ...,
    "path": "...",
    "per_page": ...,
    "to": ...,
    "total": ...
  }
}

List program members

GET https://api.upcoach.com/programs/<program_id>/members

Returns a list of members of the program

Path Parameters

Query Parameters

{
  "data": [
    {
      "id": "...",
      "avatar": "...",
      "name": "...",
      "email": "...",
      "timezone": "...",
      "role": "...",
      "created_at": ...,
      "info": {
        "...": "...",
        ...
      }
    },
    ...
  ],
  "links": {
    "first": "...",
    "last": "...",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": ...,
    "from": ...,
    "last_page": ...,
    "path": "...",
    "per_page": ...,
    "to": ...,
    "total": ...
  }
}

Add member to a program

POST https://api.upcoach.com/programs/<program_id>/members

Adds a new member to a program

Path Parameters

Request Body

{
    "program_member": {
      "id": "...",
      "avatar": "...",
      "name": "...",
      "email": "...",
      "timezone": "...",
      "role": "...",
      "created_at": ...
    }
}

Resource Objects

Program

Program Member

Inherits all the properties of the User Resource and extends it with the following properties

Last updated