Teams V2 (New)

This API endpoint provides you full control over managing teams and their structure within LinearB, including bulk operations.

Search Teams

Retrieves a paginated list of teams within the LinearB platform.

HTTP request

GET  https://public-api.linearb.io/api/v2/teams

Body parameters

Parameter name	Value	Description
offset	integer	The number of items to skip before starting the page. (The default is 0)
page_size	integer	Number of items to return per page. (Minimum: 1, Maximum: 50, Default: 50)
search_term	string	Optional text to filter teams by name. (Min length: 1, Max length: 100)
nonmerged_members_only	boolean	If the flag is set to true, the API will exclude member accounts that were merged into others. If set to false, the response will include all member accounts, including those that were merged. (Default: False)

Responses

200 - Successful Response

{
 "total": 0,
 "items": [
    { 
     "id": 0,
     "organization_id": 0,
     "name": "string",
     "created_at": "string",
     "initials": "string",
     "color": "string",
     "extra": {},
     "parent_id": 0,
     "contributors": [
        {
         "id": 0,
         "name": "string",
         "parent_id": 0,
         "provider_id": "string",
         "roles": [
            {}
          ]
        }
      ]
    }
  ]
}

400 - Bad Request

401 - Unauthorized

403 - Forbidden

404 - Not Found

405 - Method Not Allowed

409 - Conflict

422 - Validation Error

500 - Internal Server Error

504 - Gateway Timeout

Create Teams

Creates one or more teams in LinearB.

HTTP request

POST  https://public-api.linearb.io/api/v2/teams

Body parameters

Parameter name	Value	Description
name (required)	string	The team’s display name. Required. Must be 3–100 characters and start with a letter.
parent_team	string	Optional. Name of an existing team to use as a parent in a hierarchy.
initials	string	Optional. 1–3 character abbreviation of the team name.
color	string	Optional. Hex color code in #RGB or #RRGGBB format. (Default: #348B83)

Examples

[
   {
    "name": "string",
    "parent_team": "string",
    "initials": "str",
    "color": "#3B48B3"
   }
]

Responses

200 - Successful Response

{
    "job_id": "string",
    "message": "string"
}

400 - Bad Request

401 - Unauthorized

403 - Forbidden

404 - Not Found

405 - Method Not Allowed

409 - Conflict

422 - Validation Error

500 - Internal Server Error

504 - Gateway Timeout

Update Team

Updates properties of a team based on the provided team ID.

HTTP request

PATCH  https://public-api.linearb.io/api/v2/teams/{team_id}

Body parameters

Parameter name	Value	Description
name	string	The team’s display name. Required. Must be 3–100 characters and start with a letter.
parent_team	string	Optional. Name of an existing team to use as a parent in a hierarchy.
initials	string	Optional. 1–3 character abbreviation of the team name.
color	string	Optional. Hex color code in #RGB or #RRGGBB format. (Default: #348B83)

Responses

200 - Successful Response

400 - Bad Request

401 - Unauthorized

403 - Forbidden

404 - Not Found

405 - Method Not Allowed

409 - Conflict

422 - Validation Error

500 - Internal Server Error

504 - Gateway Timeout

Delete Team

Deletes a team identified by the provided team ID.

HTTP request

DELETE  https://public-api.linearb.io/api/v2/teams/{team_id}

Responses

200 - Successful Response

204 - Successful Response

400 - Bad Request

401 - Unauthorized

403 - Forbidden

404 - Not Found

405 - Method Not Allowed

409 - Conflict

422 - Validation Error

500 - Internal Server Error

504 - Gateway Timeout

Add Members to Team

Adds one or more users to a team.

HTTP request

PATCH  https://public-api.linearb.io/api/v2/teams/{team_id}/members

Body parameters

Parameter name	Value	Description
user_ids	array of objects	Each object must include an `id` and optional `joined_at` timestamp.
emails	array of objects	Each object must include an `email` and optional `joined_at` timestamp.

Responses

200 - Successful Response

400 - Bad Request

401 - Unauthorized

403 - Forbidden

404 - Not Found

405 - Method Not Allowed

409 - Conflict

422 - Validation Error

500 - Internal Server Error

504 - Gateway Timeout

Remove Member from Team

Removes a specific member from a team using their user ID or email.

HTTP request

DELETE  https://public-api.linearb.io//api/v2/teams/{team_id}/members/{user_id_or_email}

Path parameters

Parameter name	Value	Description
team_id	integer	ID of the team.
user_id_or_email	string	The user’s ID or email to remove.

Responses

200 - Successful Response

204 - Successful Response

400 - Bad Request

401 - Unauthorized

403 - Forbidden

404 - Not Found

405 - Method Not Allowed

409 - Conflict

422 - Validation Error

500 - Internal Server Error

504 - Gateway Timeout