WorkspaceWorkspace Access

Workspace Access

List the organizations, tenants, and sources accessible to the current credential.

curl -X GET "https://api.beacon.hard.al/v1/workspace/access?limit=example_string&offset=example_string" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "success": true,
  "data": {
    "tenants": [
      {
        "id": "2f1c7c3e-6c1a-4f1e-9b7a-2d8e4c1a9f10",
        "name": "Acme Store",
        "reportType": "ecommerce",
        "reportingCurrency": "USD",
        "organization": {
          "id": "5d2a8f41-9c3e-4b7a-8e16-0f4c2b9d7a53",
          "name": "Acme"
        },
        "sources": [
          {
            "id": "7b0e5a54-1d43-4c8e-8d2f-5a9c3e6b1f27",
            "name": "Website",
            "domain": "acme.example"
          }
        ]
      },
      {
        "id": "9a6e3b70-2d5f-4c18-b3a9-6e1f8d2c4b05",
        "name": "Acme Blog",
        "reportType": "default",
        "reportingCurrency": null,
        "organization": {
          "id": "5d2a8f41-9c3e-4b7a-8e16-0f4c2b9d7a53",
          "name": "Acme"
        },
        "sources": [
          {
            "id": "e3f9c1d2-7a48-4b6e-9d05-1c8a2f7b6e94",
            "name": "Blog",
            "domain": null
          }
        ]
      }
    ]
  },
  "meta": {
    "total": 2,
    "limit": 50,
    "offset": 0,
    "hasNext": false
  },
  "timestamp": "2026-11-01T09:30:00.000Z",
  "path": "/v1/workspace/access",
  "requestId": "req_01JD2V8Q9Z6R4XK7T3M5N8P2WA"
}
GET
/v1/workspace/access
GET
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

OAuth access token (token exchange) or organization API key.

OAuth access token (token exchange) or organization API key.
query
limitstring

Maximum number of tenants to return, 1 to 100. Defaults to 50.

Min: 1 • Max: 100
query
offsetstring

Number of tenants to skip. Defaults to 0. meta.hasNext tells whether more tenants follow.

Min: 0
Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. OAuth access token (token exchange) or organization API key.

Query Parameters

limitstring

Maximum number of tenants to return, 1 to 100. Defaults to 50.

offsetstring

Number of tenants to skip. Defaults to 0. meta.hasNext tells whether more tenants follow.

Responses

successboolean
Required
Allowed values:true
dataobject
Required
metaobject
timestampstring
Required
pathstring
Required
requestIdstring
Required