Teams API

1 Get Teams GET /team
- 1.1 Header parameters
- 1.2 Query Parameters
- 1.3 Response Schema
- 1.4 Examples
2 Create Team POST /team
- 2.1 Header parameters
- 2.2 Request Body
- 2.3 Examples
3 Update Team PUT /team/{teamId}
- 3.1 Header parameters
- 3.2 Path variables
- 3.3 Request Body
- 3.4 Examples
4 Delete Team DELETE /team/{teamId}
- 4.1 Header parameters
- 4.2 Path variables
- 4.3 Examples
5 Archive Team POST /team/{teamId}/archive
- 5.1 Header parameters
- 5.2 Path variables
- 5.3 Examples
6 Restore Team POST /team/{teamId}/restore
- 6.1 Header parameters
- 6.2 Path variables
- 6.3 Examples

Get information about the configured Teams and their current status.

All requests need to be made to this base URL:

https://jttp-cloud.everit.biz/timetracker/api/latest/public

Get Teams `GET /team`

Header parameters

Header Parameter	Optional	Description

Header Parameter	Optional	Description
x-everit-api-key	❌	Generated Everit authentication token, see: https://everit.atlassian.net/wiki/spaces/TCDS/pages/3531442081

Query Parameters

The available query parameters for the request:

Query Parameter	Value type	Optional	Description

Query Parameter

Value type

Optional

Description

archived

boolean

✅

Filter the teams based on the archived status. If this parameter is not provided all teams will be returned.

Example: /public/team?archived=true

Response Schema

Teams

Field	Type	Description

Field	Type	Description
teams	array of `Team`	The list of individual teams.

Team

Field	Type	Optional	Description

Field	Type	Optional	Description
id	number (Long)	❌	Unique identifier of the team.
name	string	❌	The name of the team.
description	string	✅	The description of the team.
leadAccountId	string	❌	The account ID of the team lead.
members	array of `TeamMember`	✅	List of members of the team with their roles.
projects	array of string	✅	List of project IDs associated with the team.
archived	boolean	❌	Indicates whether the team is archived.

TeamMember

Parameter	Value Type	Optional	Description

Parameter	Value Type	Optional	Description
role	string	❌	The role of the member in the team.
accountId	number	❌	The account ID of the member.

Examples

GET URL: TIME_TRACKER_BASE_URL/timetracker/api/latest/public/team

Example response:

200 Successful operation:

{
    "teams": [
        {
            "archived": false,
            "description": "Team responsible for frontend and backend development",
            "id": 1,
            "leadAccountId": "5f9c2a1e8b3d4c0017aa91e2",
            "members": [
              {
                "accountId": "5f9c2a1e8b3d4c0017aa91e2",
                "role": "lead developer"
              },
              {
                "accountId": "61a7d2f49b8e4a006c3f112a",
                "role": "developer"
              },

              {
                "accountId": "62c4e8a19f3b1d0071bb42cd",
                "role": "tester"
              }
            ],
            "name": "Aurora Team",
            "projects": [
              "10001",
              "10007",
              "10021"
            ]
        },
        {
          "archived": false,
          "description": "Marketing team responsible for campaigns and content",
          "id": 2,
          "leadAccountId": "65b1e8c92a4d7f0099aa5501",
          "members": [

            {
              "accountId": "64f2a7c18d9e3b0066cc7812",
              "role": "content-manager"
            },
            {
              "accountId": "63e9b4a7c2d8f10055aa3321",
              "role": "designer"
            },
            {
              "accountId": "62d3f8a9b7e4c20044bb1190",
              "role": "marketing-specialist"
            }
          ],
          "name": "Brand & Marketing Team",
          "projects": [
            "30002",
            "30005",
            "30009"
          ]
        }

    ]
}

401 Unauthorized

479 The user does not have one of the necessary Timetracker permissions that can be set in the Global Settings.

Create Team `POST /team`

Header parameters

Header Parameter	Optional	Description

Header Parameter	Optional	Description
x-everit-api-key	❌	Generated Everit authentication token, see: https://everit.atlassian.net/wiki/spaces/TCDS/pages/3531442081
x-requested-by	❌	CSRF protection parameter.

Request Body

TeamRequest

Parameter	Value type	Optional	Description

Parameter	Value type	Optional	Description
name	string	❌	The name of the team.
description	string	✅	The description of the team.
leadAccountId	string	❌	The account ID of the team lead.
members	array of `TeamMember`	✅	List of members to add to the team initially, with their roles.
projects	array of string	✅	List of project IDs associated with the team.

TeamMember

Parameter	Value Type	Optional	Description

Parameter	Value Type	Optional	Description
role	string	❌	The role of the member in the team.
accountId	number	❌	The account ID of the member.

Examples

POST URL: TIME_TRACKER_BASE_URL/timetracker/api/latest/public/team

Example post body:

{
    "description": "Marketing team responsible for campaigns and content",
    "leadAccountId": "65b1e8c92a4d7f0099aa5501",
    "members": [
      {
        "accountId": "64f2a7c18d9e3b0066cc7812",
        "role": "content-manager"
      },
      {
        "accountId": "63e9b4a7c2d8f10055aa3321",
        "role": "designer"
      },
      {
        "accountId": "62d3f8a9b7e4c20044bb1190",
        "role": "marketing-specialist"
      }
    ],
    "name": "Brand & Marketing Team",
    "projects": [
      "30002",
      "30005",
      "30009"
    ]
}

Example response:

200 Successful operation:

{
    "archived": false,
    "description": "Marketing team responsible for campaigns and content",
    "id": 2,
    "leadAccountId": "65b1e8c92a4d7f0099aa5501",
    "members": [
        {
            "accountId": "64f2a7c18d9e3b0066cc7812",
            "role": "content-manager"
        },
        {
            "accountId": "63e9b4a7c2d8f10055aa3321",
            "role": "designer"
        },
        {
            "accountId": "62d3f8a9b7e4c20044bb1190",
            "role": "marketing-specialist"
        }
    ],
    "name": "Brand & Marketing Team",
    "projects": [
        "30002",
        "30005",
        "30009"
    ]
}

401 Unauthorized.

400 Invalid parameters: An object that holds all field and non-field related errors.

479 The user does not have one of the necessary Timetracker permissions that can be set in the Global Settings.

Update Team `PUT /team/{teamId}`

Header parameters

Header Parameter	Optional	Description

Header Parameter	Optional	Description
x-everit-api-key	❌	Generated Everit authentication token, see: https://everit.atlassian.net/wiki/spaces/TCDS/pages/3531442081
x-requested-by	❌	CSRF protection parameter.

Path variables

The available path variables for the request:

Path Variable	Value type	Optional	Description

Path Variable

Value type

Optional

Description

teamId

number

❌

The ID of the team.

Example: /public/team/2

Request Body

TeamRequest

Parameter	Value type	Optional	Description

Parameter	Value type	Optional	Description
name	string	❌	The name of the team.
description	string	✅	The description of the team.
leadAccountId	string	❌	The account ID of the team lead.
members	array of `TeamMember`	✅	List of members to add to the team initially, with their roles.
projects	array of string	✅	List of project IDs associated with the team.

TeamMember

Parameter	Value Type	Optional	Description

Parameter	Value Type	Optional	Description
role	string	❌	The role of the member in the team.
accountId	number	❌	The account ID of the member.

Examples

PUT URL: TIME_TRACKER_BASE_URL/timetracker/api/latest/public/team/2

Example post body:

{
    "description": "Marketing team responsible for campaigns and content",
    "leadAccountId": "62d3f8a9b7e4c20044bb1190",
    "members": [
      {
        "accountId": "64f2a7c18d9e3b0066cc7812",
        "role": "content-manager"
      },
      {
        "accountId": "62d3f8a9b7e4c20044bb1190",
        "role": "marketing-specialist"
      }
    ],
    "name": "Updated Brand & Marketing Team",
    "projects": [
      "30002"
    ]
}

Example response:

200 Successful operation:

{
    "archived": false,
    "description": "Marketing team responsible for campaigns and content",
    "id": 2,
    "leadAccountId": "62d3f8a9b7e4c20044bb1190",
    "members": [
        {
            "accountId": "64f2a7c18d9e3b0066cc7812",
            "role": "content-manager"
        },
        {
            "accountId": "62d3f8a9b7e4c20044bb1190",
            "role": "marketing-specialist"
        }
    ],
    "name": "Updated Brand & Marketing Team",
    "projects": [
        "30002"
    ]
}

Example error response:

401 Unauthorized

404 Not found.

400 Invalid parameters: An object that holds all field and non-field related errors

479 The user does not have one of the necessary Timetracker permissions that can be set in the Global Settings.

Delete Team `DELETE /team/{teamId}`

Header parameters

Header Parameter	Optional	Description

Header Parameter	Optional	Description
x-everit-api-key	❌	Generated Everit authentication token, see: https://everit.atlassian.net/wiki/spaces/TCDS/pages/3531442081
x-requested-by	❌	CSRF protection parameter.

Path variables

The available path variables for the request:

Path Variable	Value type	Optional	Description

Path Variable

Value type

Optional

Description

teamId

number

❌

The ID of the team.

Example: /public/team/1

Examples

DELETE URL: TIME_TRACKER_BASE_URL/timetracker/api/latest/public/team/1

204 Successful operation.

401 Unauthorized

400 Invalid parameters: An object that holds all field and non-field related errors

479 The user does not have one of the necessary Timetracker permissions that can be set in the Global Settings.

Archive Team `POST /team/{teamId}/archive`

Header parameters

Header Parameter	Optional	Description

Header Parameter	Optional	Description
x-everit-api-key	❌	Generated Everit authentication token, see: https://everit.atlassian.net/wiki/spaces/TCDS/pages/3531442081
x-requested-by	❌	CSRF protection parameter.

Path variables

The available path variables for the request:

Path Variable	Value type	Optional	Description

Path Variable

Value type

Optional

Description

teamId

number

❌

The ID of the team.

Example: /public/team/1

Examples

POST URL: TIME_TRACKER_BASE_URL/timetracker/api/latest/public/team/1/archive

Example response:

204 Successful operation.

401 Unauthorized

404 Not found.

400 Invalid parameters: An object that holds all field and non-field related errors

479 The user does not have one of the necessary Timetracker permissions that can be set in the Global Settings.

Restore Team `POST /team/{teamId}/restore`

Header parameters

Header Parameter	Optional	Description

Header Parameter	Optional	Description
x-everit-api-key	❌	Generated Everit authentication token, see: https://everit.atlassian.net/wiki/spaces/TCDS/pages/3531442081
x-requested-by	❌	CSRF protection parameter.

Path variables

The available path variables for the request:

Path Variable	Value type	Optional	Description

Path Variable

Value type

Optional

Description

teamId

number

❌

The ID of the team.

Example: /public/team/1

Examples

POST URL: TIME_TRACKER_BASE_URL/timetracker/api/latest/public/team/1/restore

Example response:

204 Successful operation.

401 Unauthorized

404 Not found.

400 Invalid parameters: An object that holds all field and non-field related errors

479 The user does not have one of the necessary Timetracker permissions that can be set in the Global Settings.

Teams API

Get Teams GET /team

Header parameters

Query Parameters

Response Schema

Examples

Create Team POST /team

Header parameters

Request Body

Examples

Update Team PUT /team/{teamId}

Header parameters

Path variables

Request Body

Examples

Delete Team DELETE /team/{teamId}

Header parameters

Path variables

Examples

Archive Team POST /team/{teamId}/archive

Header parameters

Path variables

Examples

Restore Team POST /team/{teamId}/restore

Header parameters

Path variables

Examples

Get Teams `GET /team`

Create Team `POST /team`

Update Team `PUT /team/{teamId}`

Delete Team `DELETE /team/{teamId}`

Archive Team `POST /team/{teamId}/archive`

Restore Team `POST /team/{teamId}/restore`