Skip to main content
POST
Search Entity Types

Authentication and permissions

Token requirements: User-based token (OAuth) or Organization-scoped API key or Team-scoped API key. Send a bearer access token for one of these identities. The permissions and resource restrictions below also apply.
Permissions joined by + are all required; or separates alternatives. Full-access keys still cannot call endpoints marked unsupported. Team keys must allow every team checked by the request. OAuth access depends on the user’s roles and resource access.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
teamId
string

The ID of the team the caller acts as.

key
string | null

Optional filter by entity type key. Matches across the team's own databases and the databases shared with it, the team's own type first when a shared type has the same key.

pageSize
integer<int32> | null

Maximum number of results to return. Default is 5000, maximum is 10000.

pageToken
string | null

Token for pagination. Leave empty for the first request.

Response

200 - application/json

Success

data
EntityTypeWithFields · object[]

The list of matching entity types.

nextPageToken
string | null

Token for retrieving the next page of results. Empty if no more results.