GET/projects/api/v3/statuses/timeline.json

Get the people statuses timeline.

Return a timeline list of people statuses that the logged-in user can access.

Query Params

  • Name
    searchTerm
    Type
    string
    Description

    filter by the user name or status message

  • Name
    teamId
    Type
    integer
    Description

    filter by team

  • Name
    pageSize
    Type
    integer
    Description

    number of items in a page

    Default
    50
  • Name
    page
    Type
    integer
    Description

    page number

    Default
    1
  • Name
    skipCounts
    Type
    boolean
    Description

    SkipCounts allows you to skip doing counts on a list API endpoint for performance reasons.

  • Name
    showDeleted
    Type
    boolean
    Description

    showDeleted statuses

    Default
    false
  • Name
    includeSubteams
    Type
    boolean
    Description

    also include statuses from subteams

  • Name
    include
    Type
    array[string]
    Description

    include

    Format
    Comma separated values
    Allowed values
    • users
    • userevents
  • Name
    fields[users]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • firstName
    • lastName
    • title
    • email
    • companyId
    • company
    • isAdmin
    • isClientUser
    • isServiceAccount
    • type
    • deleted
    • avatarUrl
    • lengthOfDay
    • workingHoursId
    • workingHour
    • userRate
    • userCost
    • canAddProjects

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 OK
    TimelineResponse contains information about a group of statuses.
  • Code
    400
    Type
    object
    Schema
    Description
    400 Bad Request
    ErrorResponse defines how []Error should be marshaled to JSON.

Examples

200 OK

TimelineResponse
{
  "included": {
    "userEvents": {
      "additionalProp": {
        "clockedIn": true
      }
    },
    "users": {
      "additionalProp": {
        "avatarUrl": "string",
        "canAddProjects": true,
        "company": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "companyId": 0,
        "companyRoleId": 0,
        "createdAt": "string",
        "createdBy": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "deleted": true,
        "email": "string",
        "firstName": "string",
        "id": 0,
        "isAdmin": true,
        "isClientUser": true,
        "isPlaceholderResource": true,
        "isServiceAccount": true,
        "jobRoles": [
          {
            "id": 0,
            "meta": {},
            "type": "string"
          }
        ],
        "lastName": "string",
        "lengthOfDay": 0,
        "meta": {},
        "teams": [
          {
            "id": 0,
            "meta": {},
            "type": "string"
          }
        ],
        "timezone": "string",
        "title": "string",
        "type": "string",
        "updatedAt": "string",
        "updatedBy": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "userCost": 0,
        "userRate": 0,
        "workingHour": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "workingHoursId": 0
      }
    }
  },
  "meta": {
    "averageSpend": 0,
    "limit": 0,
    "nextCursor": "string",
    "page": {
      "count": 0,
      "hasMore": true,
      "pageOffset": 0,
      "pageSize": 0
    },
    "prevCursor": "string",
    "totalCapacity": 0
  },
  "statuses": [
    {
      "dateLastUpdated": "string",
      "dateTime": "string",
      "deleted": true,
      "emoji": "string",
      "id": 0,
      "ipAddress": "string",
      "text": "string",
      "updatedAt": "string",
      "user": {
        "id": 0,
        "meta": {},
        "type": "string"
      },
      "userId": 0
    }
  ]
}
Download Swagger