list_model_collaborators
List all active and pending collaborators for a model. Requires Owner role on the model because the result includes collaborator email addresses and pending invitations. Pass workspace_id to list collaborators for a model in a workspace other than your current one (requires an active membership and Owner grant on the model there; OAuth/JWT sessions only).
read-only · idempotent
Parameters
Section titled “Parameters”| Name | Type | Required | Default | Description |
|---|---|---|---|---|
model_name | Annotated[str, Field(description='Name of the Bridge Town model. Caller must have Owner role.')] | Yes | — | |
limit | Annotated[int, Field(ge=1, le=200, description='Maximum collaborators per page (default 50).')] | No | 50 | |
cursor | `Annotated[str | None, Field(description=‘Opaque continuation cursor from a previous list_model_collaborators response.’)]` | No | None |
workspace_id | `Annotated[str | None, Field(description=WORKSPACE_ID_FIELD_DESCRIPTION)]` | No | None |
Returns
Section titled “Returns”Returns a structured object. Top-level fields:
model(string)collaborators(array<object>)count(integer)
See the response example below for the full payload shape.
Example
Section titled “Example”Tool Call
Section titled “Tool Call”{ "name": "list_model_collaborators", "arguments": { "model_name": "forecasts" }}Response
Section titled “Response”{ "model": "forecasts", "collaborators": [ { "grant_id": "99999999-9999-9999-9999-999999999999", "email": "alice@example.com", "display_name": "Alice", "role": "owner", "pending": false }, { "grant_id": "55555555-5555-5555-5555-555555555555", "email": "bob@example.com", "display_name": "Bob", "role": "editor", "pending": false } ], "count": 2}- Module:
Collaborators - Requires an authenticated Bridge Town session (OAuth) or an API token.