Get filtered messages

GET /api/2.0/project/message/filter

Request

Returns a list with the detailed information about all the messages matching the filter parameters specified in the request.

Authorization

An API key is a token that you provide when making API calls. Include the token in a header parameter called Authorization.

Example: Authorization: 864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json.

Content-Typeenum of string

Can be one of: application/json.

Body

projectidinteger

Project ID

taginteger

Project tag

departamentstring

Departament GUID

participantstring

Participant GUID

createdStartstring

Minimum value of message creation date

createdStopstring

Maximum value of message creation date

lastIdinteger

Last message ID

myProjectsboolean

Specifies whether to return messages only from my projects or not

followboolean

Specifies whether to return messages only from followed discussions or not

statusarray of integer

Message status ("Open" or "Archived")

Examples

GET /api/2.0/project/message/filter HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.com

curl --request GET \
  --url https://example.com/api/2.0/project/message/filter \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

Responses

200

List of messages

ProjectOwnerobject

Idintegerformat: int32

Titlestring

Statusintegerformat: int32

IsPrivateboolean

Textstring

CanCreateCommentboolean

CanEditboolean

CommentsCountintegerformat: int32

Createdstring

CreatedByobject

Idstringformat: uuid

DisplayNamestring

Titlestring

AvatarSmallstring

ProfileUrlstring

CreatedByIdstringformat: uuid

Updatedstring

UpdatedByobject

Idstringformat: uuid

DisplayNamestring

Titlestring

AvatarSmallstring

ProfileUrlstring

UpdatedByIdstringformat: uuid

Idintegerformat: int32

Titlestring

Descriptionstring

Statusintegerformat: int32

Responsibleobject

Idstringformat: uuid

DisplayNamestring

Titlestring

AvatarSmallstring

ProfileUrlstring

ResponsibleIdstringformat: uuid

401

Unauthorized