List Teams

Request

GET

https://api.sourcecraft.tech/orgs/{org_slug}/teams

Path parameters

Name

Description

org_slug

Type: string

Example: ``

Query parameters

Name	Description
org_id	Type: string Example: ``
page_size	Type: string<uint64> Example: ``
page_token	Type: string Example: ``
sort_by	Type: string Ordering options: comma separated list of fields. Default sorting order is ascending. To specify descending order for a field, append a "-" prefix; for example: "slug, -members_count" Available fields: slug, members_count Example: ``

Responses

200 OK

A successful response.

Body

application/json

{
  "teams": [
    {
      "id": "example",
      "slug": "example",
      "description": "example",
      "members_count": "example",
      "organization": {
        "id": "example",
        "slug": "example"
      }
    }
  ],
  "next_page_token": "example"
}

Name

Description

next_page_token

Type: string

Example: example

teams

Type: Team[]

Example

[
  {
    "id": "example",
    "slug": "example",
    "description": "example",
    "members_count": "example",
    "organization": {
      "id": "example",
      "slug": "example"
    }
  }
]

OrganizationEmbedded

Name

Description

Type: string

Example: example

slug

Type: string

Example: example

Example

{
  "id": "example",
  "slug": "example"
}

Team

Name	Description
description	Type: string Example: `example`
id	Type: string IAM group ID of the team. Use this value as `Subject.id` when assigning roles with `type`=`team`. Example: `example`
members_count	Type: string<int64> Example: `example`
organization	Type: OrganizationEmbedded Example `{ "id": "example", "slug": "example" }`
slug	Type: string Example: `example`

Example

{
  "id": "example",
  "slug": "example",
  "description": "example",
  "members_count": "example",
  "organization": {
    "id": "example",
    "slug": "example"
  }
}

default

Both Client Errors (4xx) and Server Errors (5xx) are serialized into this scheme

Body

application/json

{
  "error_code": "example",
  "message": "example",
  "request_id": "example",
  "details": null
}

Name	Description
details	Type: unknown Example: `null`
error_code	Type: string Example: `example`
message	Type: string Example: `example`
request_id	Type: string Example: `example`

Was the article helpful?

Create Team (By Organization ID)

Create Team