Skip to main content
curl --request GET \
  --url https://api.baseten.co/v1/gateway/groups \
  --header "Authorization: Api-Key $BASETEN_API_KEY"

{
  "items": [
    {
      "id": "abc123hash",
      "metadata": { "name": "Acme prod", "external_entity_id": "cust_42" },
      "models": [
        {
          "slug": "your-org/your-model",
          "rate_limits": [
            { "type": "TOKEN", "unit": "MINUTE", "threshold": 1000000 }
          ],
          "usage_limits": []
        }
      ],
      "effective_models": [
        {
          "slug": "your-org/your-model",
          "rate_limits": [
            { "type": "TOKEN", "unit": "MINUTE", "threshold": 1000000, "source_group": "abc123hash" }
          ],
          "usage_limits": []
        }
      ],
      "hierarchy": { "limit_enforcement": "INDEPENDENT", "parent_group_id": null },
      "created_at": "2026-05-13T12:00:00Z"
    }
  ],
  "pagination": {
    "has_more": true,
    "cursor": "aVd2Yk54T2d2V0dFWE13R1l4R2k5UVE="
  }
}
List groups visible to your workspace, cursor-paginated. Pass external_entity_id to look up a single group by its external identifier.

​
Authentication

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

​
Query parameters

​
external_entity_id
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.
​
limit
integer
Page size. Default 100, maximum 1000.
​
cursor
string
Pagination cursor from the previous response’s pagination.cursor. Omit on the first call.

​
Response

​
items
object[]
required
Group objects. Each item has the same shape returned by Create a group: id, metadata, models, effective_models, hierarchy, created_at.
​
pagination
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

StatusMeaning
403 ForbiddenWorkspace isn’t onboarded to Frontier Gateway, or the caller doesn’t have view scope.
curl --request GET \
  --url https://api.baseten.co/v1/gateway/groups \
  --header "Authorization: Api-Key $BASETEN_API_KEY"

{
  "items": [
    {
      "id": "abc123hash",
      "metadata": { "name": "Acme prod", "external_entity_id": "cust_42" },
      "models": [
        {
          "slug": "your-org/your-model",
          "rate_limits": [
            { "type": "TOKEN", "unit": "MINUTE", "threshold": 1000000 }
          ],
          "usage_limits": []
        }
      ],
      "effective_models": [
        {
          "slug": "your-org/your-model",
          "rate_limits": [
            { "type": "TOKEN", "unit": "MINUTE", "threshold": 1000000, "source_group": "abc123hash" }
          ],
          "usage_limits": []
        }
      ],
      "hierarchy": { "limit_enforcement": "INDEPENDENT", "parent_group_id": null },
      "created_at": "2026-05-13T12:00:00Z"
    }
  ],
  "pagination": {
    "has_more": true,
    "cursor": "aVd2Yk54T2d2V0dFWE13R1l4R2k5UVE="
  }
}