Users

Resources and actions to manage the users of an organization

Endpoints

get
https://api.upcoach.com/me/
Get authentication organization and user information
get
https://api.upcoach.com/team-members
List team members
get
https://api.upcoach.com/clients
List clients
post
https://api.upcoach.com/clients
Add new client
put
https://api.upcoach.com/clients
/<user_id>
Update a client

Resource Objects

User

Property
Type
Description
id
string
User ID
name
string
User's full name
email
string
User's email address
avatar
string
User avatar URL
timezone
string
User's timezone
​Team Member, Client and Program Member resource objects inherit properties from this User resource object.

Organization

Property
Type
Description
id
string
Organization ID
name
string
Organization name
subdomain
string
Organization subdomain
url_home
string
Organization home URL
created_at
integer
Organization created at (Unix timestamp)

Team Member

Inherits all the properties of the User Resource and extends it with the following properties
Property
Type
Description
role
string
Team role, can be admin or coach
created_at
integer
Team member created at (Unix timestamp)

Client

Inherits all the properties of the User Resource and extends it with the following properties
Property
Type
Description
created_at
integer
Client created at (Unix timestamp)
info
object or null
A key-value object listing all the client custom fields. If there are no custom fields, it will be a null value