v1

latestOpenAPI 3.0.12026-08-041753011.2 MB

Scheduling (Deprecated)

Get all scheduled assignments per project

get/v1/workspaces/{workspaceId}/scheduling/assignments/projects/totals

Path parameters

workspaceIdstring required

Represents a workspace identifier across the system.

Example:64a687e29ae1f428e7ebe303

Represents a workspace identifier across the system.

Query parameters

searchstring

Represents a term for searching projects and clients by name.

Example:Project name

Represents a term for searching projects and clients by name.

startstring required

Represents a start date in the yyyy-MM-ddThh:mm:ssZ format.

Example:2020-01-01T00:00:00Z

Represents a start date in the yyyy-MM-ddThh:mm:ssZ format.

endstring required

Represents an end date in the yyyy-MM-ddThh:mm:ssZ format.

Example:2021-01-01T00:00:00Z

Represents an end date in the yyyy-MM-ddThh:mm:ssZ format.

pageinteger

Page number.

Example:1

Page number.

page-sizeinteger

Page size.

Example:50

Page size.

Response

clientNamestring

Represents project name.

projectArchivedboolean

Indicates whether project is archived or not.

projectBillableboolean

Indicates whether project is billable or not.

projectColorstring

Color format ^#(?:[0-9a-fA-F]{6}){1}$. Explanation: A valid color code should start with '#' and consist of six hexadecimal characters, representing a color in hexadecimal format. Color value is in standard RGB hexadecimal format.

projectIdstring

Represents project identifier across the system.

projectNamestring

Represents project name.

taskIdstring

Represents task identifier across the system.

taskNamestring

Represents task name.

totalHoursnumber double

Represents project total hours as double.

workspaceIdstring

Represents workspace identifier across the system.

Example response

[
  {
    "clientName": "Software Development",
    "milestones": [
      {
        "date": "2020-01-01T08:00:00Z",
        "id": "34a687e29ae1f428e7ebe303",
        "name": "Q3",
        "projectId": "5b641568b07987035750505e",
        "workspaceId": "64a687e29ae1f428e7ebe303"
      }
    ],
    "projectColor": "#000000",
    "projectId": "56b687e29ae1f428e7ebe504",
    "projectName": "Software Development",
    "taskId": "36b687e29ae1f428e7ebe109",
    "taskName": "Bugfixing",
    "totalHours": 490.5,
    "workspaceId": "64a687e29ae1f428e7ebe303"
  }
]