PilotFoxDocs

List sites

GET
/api/v1/orgs/{orgId}/sites

The organization's sites the caller sees: a user the sites they have a role on, an API key the sites it is limited to (all when it is not), each with the caller's role and permissions there.

Requires site:read in the organization (an API key, or a signed-in member's role; a member restricted to some sites holds a viewer's permissions here). API keys limited to some sites: allowed, and see only those sites. Share links: 401.

Authorization

headerx-api-key<token>

An organization API key (ak_…), with the permissions and the sites it was created with. For servers and scripts: no cookie and no Origin check. Also accepted as Authorization: Bearer ak_… (apiKeyBearer). A request carries one credential: a key sent with a share token or a live session cookie is 400 (details.reason: ambiguous_credentials).

Scope: site:read

Path Parameters

orgId*string

Response Body

OK

application/json
  1. response
data*array<>
Example Request
curl -X GET 'https://pilotfox.app/api/v1/orgs/string/sites'
Example Response200
{  "data": [    {      "id": "string",      "name": "string",      "domain": "string",      "timezone": "string",      "kind": "web",      "settings": {        "tracking": {          "initialPageview": true,          "spa": true,          "hashRouting": false,          "querystring": true,          "outbound": true,          "clicks": false,          "forms": false,          "copy": false,          "inputs": false,          "errors": false,          "vitals": false,          "paymentLinks": true        },        "replay": {          "enabled": false,          "sampleRate": 100,          "maskAllInputs": true,          "maskTextSelector": null,          "blockSelector": null,          "minDurationSeconds": 0        },        "identity": {          "mode": "stable"        },        "privacy": {          "storeQuerystringParams": "all",          "stripParams": [],          "respectGpc": true        },        "allowedHostnames": [],        "exclusions": {          "ips": [],          "countries": [],          "paths": [],          "userAgents": [],          "asns": []        },        "bots": {          "block": true        },        "revenue": {          "currency": "usd",          "storeCustomerEmail": false,          "attributionModel": "last_non_direct",          "attributionWindowDays": 90        },        "affiliates": {          "params": [            "ref"          ],          "windowDays": 30        },        "public": false,        "primaryGoalId": null      },      "createdAt": "2019-08-24T14:15:22Z",      "role": "owner",      "permissions": {        "property1": [          "string"        ],        "property2": [          "string"        ]      }    }  ]}