GET/projects/api/v3/messages.json

Get all messages.

Retrieve all messages for the provided filters.

Query Params

  • Name
    updatedAfter
    Type
    string
    Description

    filter by updated after date

  • Name
    searchTerm
    Type
    string
    Description

    filter by message name and body

  • Name
    projectType
    Type
    string
    Description

    filter by project type

    Default
    normal
    Allowed values
    • normal
    • tasklists-template
    • projects-template
  • Name
    projectStatuses
    Type
    string
    Description

    filter by project statuses

  • Name
    orderMode
    Type
    string
    Description

    order mode

    Default
    asc
    Allowed values
    • asc
    • desc
  • Name
    orderBy
    Type
    string
    Description

    order by

    Default
    ownermessage
    Allowed values
    • createdat
    • updatedat
    • category
    • project
    • createdby
    • unread
  • Name
    createdBefore
    Type
    string
    Description

    filter by created before date

  • Name
    createdAfter
    Type
    string
    Description

    filter by created after date

  • Name
    pageSize
    Type
    integer
    Description

    Number of items in a page See How does paging work for more detailed documentation on pagination. Minimum: 1 Maximum: 500

    Default
    50
  • Name
    page
    Type
    integer
    Description

    Page number, this is usually used in conjunction with the parameter pageSize. See How does paging work for more detailed documentation on pagination.

    Default
    1
  • Name
    updatedAfterIncludesReplies
    Type
    boolean
    Description

    consider reply dates when using updatedAfter

  • Name
    unreadOnly
    Type
    boolean
    Description

    show unread messages only

  • Name
    skipCounts
    Type
    boolean
    Description

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

  • Name
    onlyStarredProjects
    Type
    boolean
    Description

    filter by starred projects only

  • Name
    matchAllTags
    Type
    boolean
    Description

    match all tags

  • Name
    matchAllProjectTags
    Type
    boolean
    Description

    match all project tags

  • Name
    includeDeleted
    Type
    boolean
    Description

    include deleted messages

  • Name
    includeArchivedProjects
    Type
    boolean
    Description

    include archived projects

  • Name
    getEmoji
    Type
    boolean
    Description

    parse emojis to unicode

    Default
    true
  • Name
    formatMarkdown
    Type
    boolean
    Description
  • Name
    archivedOnly
    Type
    boolean
    Description

    show archived messages only

  • Name
    userIds
    Type
    array[integer]
    Description

    filter by user ids

    Format
    Comma separated values
  • Name
    tagIds
    Type
    array[integer]
    Description

    filter by tag ids

    Format
    Comma separated values
  • Name
    projectTagIds
    Type
    array[integer]
    Description

    filter by project tag ids

    Format
    Comma separated values
  • Name
    projectOwnerIds
    Type
    array[integer]
    Description

    filter by project owner ids

    Format
    Comma separated values
  • Name
    projectIds
    Type
    array[integer]
    Description

    filter by project ids

    Format
    Comma separated values
  • Name
    projectHealths
    Type
    array[integer]
    Description

    filter by project healths

    0: not set 1: bad 2: ok 3: good

    Format
    Comma separated values
    Allowed values
    • 0
    • 1
    • 2
    • 3
  • Name
    projectCompanyIds
    Type
    array[integer]
    Description

    filter by company ids

    Format
    Comma separated values
  • Name
    projectCategoryIds
    Type
    array[integer]
    Description

    filter by project category ids

    Format
    Comma separated values
  • Name
    notifiedUserIds
    Type
    array[integer]
    Description

    filter by users who got notified for the messages

    Format
    Comma separated values
  • Name
    include
    Type
    array[string]
    Description

    include

    Format
    Comma separated values
    Allowed values
    • latestreplies
    • tags
  • Name
    ids
    Type
    array[integer]
    Description

    filter by ids

    Format
    Comma separated values
  • Name
    fields[projects]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
  • Name
    fields[messageReplies]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • messageId
  • Name
    fields[companies]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
    • logoUploadedToServer
    • logoImage

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 OK
    MessagesResponse contains all the information returned when sending a GET request to the message endpoint.
  • Code
    400
    Type
    object
    Schema
    Description
    400 Bad Request
    ErrorResponse defines how []Error should be marshaled to JSON.
  • Code
    403
    Type
    object
    Schema
    Description
    403 Forbidden
    ErrorResponse defines how []Error should be marshaled to JSON.

Examples

200 OK

MessagesResponse
{  "included": {    "Included": {      "messages": {        "additionalProp": {          "attachments": [            {              "id": 0,              "meta": {},              "type": "string"            }          ],          "author": {            "id": 0,            "meta": {},            "type": "string"          },          "body": "string",
Download Swagger