List workspaces
/v1/organization/workspacesfor await (const workspace of bird.organization.workspaces.list({
name: "Staging",
})) {
console.log(workspace.id, workspace.name);
}for workspace in client.organization.workspaces.list(name="Staging"):
print(workspace.id, workspace.name)for workspace, err := range client.Organization.Workspaces.List(context.Background(), bird.OrganizationWorkspacesListParams{Name: "Staging"}) {
if err != nil {
log.Fatal(err)
}
fmt.Println(workspace.Id, workspace.Name)
}$workspaces = $bird->organization->workspaces->list(['name' => 'Staging']);
foreach ($workspaces as $workspace) {
echo $workspace->getId() . ' ' . $workspace->getName() . PHP_EOL;
}bird organization workspaces listcurl -X GET "https://us1.platform.bird.com/v1/organization/workspaces" \
-H "Authorization: Bearer $TOKEN" \
--url-query "sort=created_at" \
--url-query "order=desc" \
--url-query "limit=25" \
--url-query "include_total=false"{
"data": [
{
"id": "ws_01krdgeqcxet5s7t44vh8rt9mg",
"organization_id": "org_01krdgeqcxet5s7t44vh8rt9mg",
"name": "Production",
"notification_emails": {
"operational": [
"alerts@example.com"
]
},
"created_at": "2026-05-20T09:14:52Z",
"updated_at": "2026-05-25T16:42:01Z"
}
],
"next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
"prev_cursor": null,
"refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}
Returns a paginated list of workspaces in the organization, ordered by creation date descending by default. Organization master keys and authorized CLI or MCP access tokens need organization workspace read access. Workspace API keys cannot list the organization's workspaces.
Query पैरामीटर
namestringSubstring match against the workspace name (case-insensitive).
sortstringSort by created_at or name. Defaults to created_at.
Possible values: created_at, name
orderstringSort direction. Defaults to desc, which sorts from newest to oldest or largest to smallest, depending on the selected sort field.
Possible values: asc, desc
limitintegerMaximum number of items to return per page.
starting_afterstringCursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.
ending_beforestringCursor from the prev_cursor or refresh_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order. prev_cursor returns the preceding page. refresh_cursor anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.
include_totalbooleanWhen true, the response includes a total field with the total number of items matching the request's filters across all pages.
Response Payload
dataचाइल्ड एट्रिब्यूट दिखाएँ
data.iddata.organization_iddata.namedata.notification_emailsdata.logo_urlHTTPS URL to the current workspace logo. null when unset.
data.created_atdata.updated_atnext_cursorCursor for the next page. Pass back as starting_after to advance forward. null when no next page exists.
prev_cursorCursor for the previous page. Pass back as ending_before to step backward. null when no previous page exists.
refresh_cursorRefresh anchor, the first row of this response. Pass back as ending_before to fetch what precedes it in the current sort order. On a newest-first sort those are the items that have appeared since; on any other sort they are the items that sort earlier, so refreshing such a list means re-fetching it instead. Non-null whenever data is non-empty; null only on an empty page. Distinct from prev_cursor.
totalTotal number of items matching the request's filters across all pages. Present only when include_total=true was passed, and omitted otherwise.
संबंधित संसाधन
इस विषय के लिए दस्तावेज़, गाइड और उदाहरणों के साथ आगे बढ़ें।