projectTypes

Returns existing project types.

Changed on

Returns existing project types. Each type includes its name, icon, and archived state. <Check title="Required Permissions" icon="key">The user must have permission to access the requested resource.</Check>

get/projecttypes

Request

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

Query parameters

showArchivedboolean

Whether to include archived project types in the results. Default is false.

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 id of the type.

namestring nullable

The name of the project type.

descriptionstring nullable

A short (max. 140 characters) description of the project type.

iconstring nullable

The identifier of the project type icon.

isArchivedboolean

Whether this type is archived. It can no longer be used to create projects, but existing projects will continue using it.

isPresetboolean

Whether this type is one of the preset types. Preset types cannot be edited.

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.

updatedBystring uuid

The id of the user who last modified this entity.

Changes

  • 1556e0487867Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

  • 8e46cf415581Revision changes
    • info

      api operation id GetProjectTypes removed and replaced with projectTypes_GetProjectTypes