Skip to content
Kindgi

List the teams with a role on a project

GET
/v1/projects/{projectId}/team-grants
curl --request GET \
  --url 'https://example.com/v1/projects/example/team-grants?limit=25' \
  --header 'Authorization: Bearer <token>'

Every member of a team holds its role on the project. For the project’s editors and admins (write). Each grant names its team and project.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
projectId
required
string

ProjectId — opaque branded string.

Query Parameters

Section titled “Query Parameters”
limit
integer
default: 25 >= 1 <= 100

1..100. Default 25.

cursor
string

Where the previous page ended: its nextCursor, as it came. A runtime that seals cursors takes one only for the same list, filters and caller, within a day; otherwise 400 bad-input, and the list starts again without it. Absent → first page.

Responses

Section titled “Responses”

200

Section titled “200”

Page of team grants.

Media typeapplication/json
object
data
required
Array<object>

A team’s role on a project.

object
teamId
required
string
projectId
required
string
role
required

A team’s role on a project, held by every member of the team: admin includes editor, which includes viewer. A team never owns a project.

string
Allowed values: viewer editor admin
grantedAt

When the team was given the role. Absent from a runtime that does not record it.

string format: date-time
teamName
string
projectName
string
hasMore
required
boolean
nextCursor
string
Example
{
  "data": [
    {
      "role": "viewer"
    }
  ]
}

401

Section titled “401”

Missing / malformed / expired / revoked bearer token.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

404

Section titled “404”

No project with that id under this tenant.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}