projectStatuses

Returns project statuses in the workspace.

Changed on

Returns active project statuses by default. Set showArchived to include archived statuses visible to the current user. <Check title="Required Permissions" icon="key">The user must have access to each returned project status.</Check>

get/projectstatuses

Request

  • Base URL: https://api.awork.com/api/v1
  • URL: https://api.awork.com/api/v1/projectstatuses
  • Auth: HTTP bearer

Query parameters

showArchivedboolean

Whether to include archived project statuses.

pageinteger

Page number for pagination

pageSizeinteger

Number of items per page

orderbystring

The properties to order by

filterbystring

The filter expression to filter by

Response

OK

idstring uuid

The primary identifier of this project status.

namestring nullable

The name of the project status.

typestring nullable

The general type of this project status.

isArchivedboolean

Indicates whether this status is archived.

orderinteger nullable

The order of this status.

createdOnstring date-time

The date this entity was created.

createdBystring uuid

The id of the user who created this entity.

updatedOnstring date-time

The date this entity was last modified.

projectTemplateIdstring uuid nullable

The id of the project template of the status.

projectIdstring uuid nullable

The id of the project the status belongs to.

workflowIdstring uuid nullable

The id of the workflow linked to this project status.

updatedBystring uuid

The id of the user who last modified this entity.

isExternalboolean

True if the project status is coming from an external workspace (awork Connect).

Changes

  • 84f37b3c4cbcRevision changes
    • info

      added the optional property / to the response with the status

  • 1556e0487867Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API