Skip to main content
List groups visible to your workspace, cursor-paginated. Pass external_entity_id to look up a single group by its external identifier.

Authentication

string
required
Workspace API key with management scope, passed as Authorization: Api-Key $BASETEN_API_KEY (or Bearer; both are accepted).

Query parameters

string
Filter results to groups whose metadata.external_entity_id matches this value exactly. Because external_entity_id is unique per workspace, the response contains at most one item. Combinable with limit and cursor.
integer
Page size. Default 100, maximum 1000.
string
Pagination cursor from the previous response’s pagination.cursor. Omit on the first call.

Response

object[]
required
Group objects. Each item has the same shape returned by Create a group: id, metadata, models, effective_models, hierarchy, created_at.
object
required
  • has_more (boolean): true when more pages exist.
  • cursor (string or null): Cursor for the next page. null on the last page.

Errors