Notes Resources | Upcoach Developer Portal

Resources and actions to manage notes on organization entities

GET

https://api.upcoach.com/notes

List notes

Returns a list of notes

Parameters

Query

filter[id]

Note ID

filter[user]

User ID

Responses

200: OK

A paginated list of User Note Resource objects

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

POST

https://api.upcoach.com/notes

Add a note

Adds a note to a user

Parameters

Body

user *

User ID

text *

Note text

Responses

200: OK

Note Resource object

{
  "note": {
    "id": "...",
    "text": "...",
    "user": {
      "avatar": "...",
      "email": "...",
      "id": "...",
      "name": "...",
      "timezone": "..."
    },
    "author": {
      "avatar": "...",
      "email": "...",
      "id": "...",
      "name": "...",
      "timezone": "..."
    },
    "created_at": ...
  }
}

Resource Objects

Note

id	string	Note ID
text	string	Note text
user	User	The user note added to
author	User	The note author
created_at	integer	Note created date and time (Unix timestamp)