List Workspace Businesses
GET
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.
header
AuthorizationBearer <token>A signed-in SMB user's access token. Workspace-scoped operations also require SMB-Workspace-Id.
workspace_id*stringFormat
uuidbusiness_ids?array<>Only these. Over HTTP: repeat or comma-separate.
Items
1 <= items <= 100cursor?stringStable SMB Business ID.
Match
^biz_[0-7][0-9A-HJKMNP-TV-Z]{25}$limit?integerRange
1 <= value <= 100Default
20name?stringName contains this text.
Match
^\s*\S[\s\S]{1,198}\S\s*$Length
3 <= lengthstatus?stringDefault
"active"Value in
"active""archived""all"SMB-Workspace-Id*stringFormat
uuiddata[]; page {cursor, has_more}; projection; schema_version; as_of; provenance when permitted.
application/json- response
as_of*smb_v0_operations_search_workspace_businesses_response.__local.TimestampFormat
date-timedata*array<>page*projection*stringrequest_id*SmbV0OperationsGetBusinessRequestRevisionLength
1 <= length <= 200schema_hash*smb_v0_operations_search_workspace_businesses_response.__local.DigestMatch
^sha256:[0-9a-f]{64}$schema_version*stringLength
1 <= length <= 100curl -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", "lifecycle_status": "active", "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", "version": 1, "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"}