List Workspace Businesses
Lists Businesses visible to the caller in one Workspace, including unpublished Businesses and bounded Workspace observations. Omit name to list all accessible Businesses, one page at a time, or supply name to filter them. Requires businesses:read; the Workspace in the path and SMB-Workspace-Id header must match. Pages default to 20 Businesses, with a maximum of 100. When page.has_more is true, pass page.cursor as cursor to get the next page.
Signed-in user's Supabase access token. Workspace-scoped operations also require SMB-Workspace-Id.
In: header
Path Parameters
uuidQuery Parameters
Stable SMB Business ID.
^biz_[0-7][0-9A-HJKMNP-TV-Z]{25}$1 <= value <= 10020Optional Business name filter, 3 to 200 characters after surrounding whitespace is removed. Omit to list all visible Businesses in the Workspace, one page at a time.
^\s*\S[\s\S]{1,198}\S\s*$3 <= lengthHeader Parameters
uuidResponse Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/v1/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/businesses" \ -H "SMB-Workspace-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08"{ "as_of": "2019-08-24T14:15:22Z", "data": [ { "access_level": "view", "address": "string", "city": "string", "description": "string", "id": "string", "industry_name": "string", "latitude": -90, "logo_url": "string", "longitude": -180, "naics_code": "string", "name": "string", "postal_code": "string", "primary_classification_id": "string", "primary_location_id": "string", "state": "string", "status": "string", "website_url": "string", "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9" } ], "page": { "cursor": "string", "has_more": true }, "projection": "workspace", "request_id": "string", "schema_hash": "string", "schema_version": "string"}