Projects

Create and manage projects for task organization

Endpoints

GET/v1/folders/{folder_id}/projects
POST/v1/folders/{folder_id}/projects
GET/v1/organizations/{organization_id}/projects
GET/v1/projects
GET/v1/projects/{project_id}

List folder projects

GET/v1/folders/{folder_id}/projects

Returns a collection of projects for the given folder.

Results can be filtered by status (active/archived).

Parameters

Name	In	Type	Description
page_start_id	query	integer (int32)	The page start ID.
page_limit	query	integer (int32)	The default page size
status	query	string	Possible values`activearchived`
folder_idrequired	path	integer (int32)	A folder ID

Responses

200A list of projects

object

projectsarray
array<object>
items
object
project model
- idinteger
- namestring
- archivedboolean
- organization_idinteger
- folder_idinteger
- created_atstring
- updated_atstring

Example response

json

{
  "projects": [
    {
      "id": 0,
      "name": "string",
      "archived": false,
      "organization_id": 0,
      "folder_id": 0,
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    }
  ]
}

400Invalid parameters

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}

401Unauthorized

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}

403API access is only for organizations on an active plan

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}

404Could not find record

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}

429Rate limit exceeded

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}

Create project

POST/v1/folders/{folder_id}/projects

Creates a new project within the given folder.

Returns the created project.

Parameters

Name	In	Type	Description
folder_idrequired	path	integer (int32)	A folder ID

Request body

object

project[name]string required

Responses

201A project

object

projectobject
object
project model
- idinteger
- namestring
- archivedboolean
- organization_idinteger
- folder_idinteger
- created_atstring
- updated_atstring

Example response

json

{
  "project": {
    "id": 0,
    "name": "string",
    "archived": false,
    "organization_id": 0,
    "folder_id": 0,
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
}

400Invalid parameters

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}

401Unauthorized

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}

403API access is only for organizations on an active plan

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}

404Could not find record

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}

429Rate limit exceeded

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}

List organization projects

GET/v1/organizations/{organization_id}/projects

Returns a collection of projects for the given organization.

Results can be filtered by status (active/archived).

Parameters

Name	In	Type	Description
page_start_id	query	integer (int32)	The page start ID.
page_limit	query	integer (int32)	The default page size
status	query	string	Possible values`activearchived`
organization_idrequired	path	integer (int32)	An organization ID

Responses

200A list of projects

object

projectsarray
array<object>
items
object
project model
- idinteger
- namestring
- archivedboolean
- organization_idinteger
- folder_idinteger
- created_atstring
- updated_atstring

Example response

json

{
  "projects": [
    {
      "id": 0,
      "name": "string",
      "archived": false,
      "organization_id": 0,
      "folder_id": 0,
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    }
  ]
}

400Invalid parameters

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}

401Unauthorized

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}

403API access is only for organizations on an active plan

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}

404Could not find record

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}

429Rate limit exceeded

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}

List projects

GET/v1/projects

Returns a collection of all projects accessible to the current user.

Results can be filtered by status (active/archived).

Parameters

Name	In	Type	Description
page_start_id	query	integer (int32)	The page start ID.
page_limit	query	integer (int32)	The default page size
status	query	string	Possible values`activearchived`

Responses

200A list of projects

object

projectsarray
array<object>
items
object
project model
- idinteger
- namestring
- archivedboolean
- organization_idinteger
- folder_idinteger
- created_atstring
- updated_atstring

Example response

json

{
  "projects": [
    {
      "id": 0,
      "name": "string",
      "archived": false,
      "organization_id": 0,
      "folder_id": 0,
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    }
  ]
}

400Invalid parameters

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}

401Unauthorized

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}

403API access is only for organizations on an active plan

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}

404Could not find record

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}

429Rate limit exceeded

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}

Get project

GET/v1/projects/{project_id}

Returns the project with the given ID.

Parameters

Name	In	Type	Description
project_idrequired	path	integer (int32)	A project ID

Responses

200A project

object

projectobject
object
project model
- idinteger
- namestring
- archivedboolean
- organization_idinteger
- folder_idinteger
- created_atstring
- updated_atstring

Example response

json

{
  "project": {
    "id": 0,
    "name": "string",
    "archived": false,
    "organization_id": 0,
    "folder_id": 0,
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
}

400Invalid parameters

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}

401Unauthorized

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}

403API access is only for organizations on an active plan

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}

404Could not find record

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}

429Rate limit exceeded

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}