Skip to main content

List teams

GET 
/v2/orgs/:org_id/teams

Retrieves list of teams in an existing organization.

Required scope

organizations:teams:read

Rate limiting

Level 1

Enterprise only

This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using this form.

Request​

Path Parameters

    org_id stringrequired

    The id of the Organization.

    Example: 3074457345618265000

Query Parameters

    limit int32

    Possible values: >= 1 and <= 100

    Default value: 100

    cursor string

    An indicator of the position of a page in the full set of results. To obtain the first page leave it empty. To obtain subsequent pages set it to the value returned in the cursor field of the previous request.

    Example: 3055557345821140500
    name string

    Name query. Filters teams by name using case insensitive partial match. A value "dev" will return both "Developer's team" and "Team for developers".

    Example: My team

Responses​

Page of teams that match the search query.

Schema

    limit int32required

    Possible values: >= 1 and <= 100

    Default value: 100

    The maximum number of results to return per call. If the number of project in the response is greater than the limit specified, the response returns the cursor parameter with a value.

    size int32required

    Possible values: <= 100

    Default value: 100

    Number of results returned in the response considering the cursor and the limit values sent in the request. For example, if there are 20 results, the request does not have a cursor value, and the limit set to 10, the size of the results will be 10. In this example, the response will also return a cursor value that can be used to retrieve the next set of 10 remaining results in the collection.

    data

    object[]

    required

    List of teams

  • Array [

    • id stringrequired

    Team id

    name stringrequired

    Team name

    picture

    object

    id int64

    Id of the picture

    imageURL string

    Url of the picture

    originalUrl string

    Original team picture url for icon generation

    type string

    Default value: picture

    Type of the object returned.

    type string

    Default value: team

    Type of the object returned.

  • ]

    • cursor PageCursor (string)

    Indicator of the position of the next page of the result. To retrieve the next page, make another query setting its cursor field to the value returned by the current query. If the value is empty, there are no more pages to fetch.

    type PageType (string)

    Default value: cursor-list

    Type of the object returned.

Loading...