References

Smart Documents Resources

Endpoints

GET
https://api.upcoach.com/smart-documents
List smart documents

Returns a list of smart documents

Parameters
Query
filter[user]

String: Assignee user id

filter[program]

String: Program id

Responses
200: OK

A paginated list of Smart Document Resource Objects

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

Resource Objects

Smart Document

Property

Type

Description

id

string

Smart Document ID

user

User

Assignee user

program

Program

Program

course

Simple Course

Course

title

string

Title

progress

int

Completion progress percentage

link

string

Smart document link

created_at

integer

Created date and time (Unix timestamp)

created_at

integer

Updated date and time (Unix timestamp)

Previous
Events Resources