Get filtered projects

GET /api/2.0/project/filter

Request

Returns a list of all the portal projects filtered by project title, status, participant ID, and other 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

taginteger

Project tag

statusarray of integer

Project status ("Open", "Paused", or "Closed")

participantstring

Project participant GUID

managerstring

Project manager GUID

departamentstring

Project department

followboolean

Specifies if the current user is following this project or not

Examples

GET /api/2.0/project/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/filter \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

Responses

200

List of projects

CanEditboolean

CanDeleteboolean

Securityobject

CanCreateMilestoneboolean

CanCreateMessageboolean

CanCreateTaskboolean

CanCreateTimeSpendboolean

CanEditTeamboolean

CanReadFilesboolean

CanReadMilestonesboolean

CanReadMessagesboolean

CanReadTasksboolean

CanLinkContactboolean

CanReadContactsboolean

CanEditboolean

CanDeleteboolean

IsInTeamboolean

ProjectFolderobject

IsPrivateboolean

TaskCountintegerformat: int32

TaskCountTotalintegerformat: int32

MilestoneCountintegerformat: int32

DiscussionCountintegerformat: int32

ParticipantCountintegerformat: int32

TimeTrackingTotalstring

DocumentsCountintegerformat: int32

IsFollowboolean

Tagsarray of string

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