Skip to main content
POST
/
websites
/
list
List Projects
curl --request POST \
  --url https://api.example.com/websites/list \
  --header 'Content-Type: application/json' \
  --data '
{
  "organizationId": "<string>",
  "includeArchived": true
}
'
{
  "id": "<string>",
  "organizationId": "<string>",
  "domain": "<string>",
  "name": "<string>",
  "publicAccess": true,
  "trackingStatus": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

​
Authentication

Requires either:
  • Session authentication (browser)
  • API key with organization scope in x-api-key header or Authorization: Bearer header

​
Request Body

​
organizationId
string
required
The organization ID to list websites for
​
includeArchived
boolean
Include archived websites in results. Defaults to false

​
Response

Returns an array of website objects.
​
id
string
Unique website identifier
​
organizationId
string
Organization that owns this website
​
domain
string
Website domain (e.g., example.com)
​
name
string
Display name for the website
​
publicAccess
boolean
Whether the analytics dashboard is public
​
trackingStatus
string
Current tracking status: active, inactive, or setup_required
​
createdAt
string
ISO 8601 timestamp of creation
​
updatedAt
string
ISO 8601 timestamp of last update

​
Example Request

curl -X POST https://api.databuddy.cc/websites/list \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "organizationId": "org_abc123"
  }'

​
Example Response

[
  {
    "id": "web_xyz789",
    "organizationId": "org_abc123",
    "domain": "example.com",
    "name": "Example Website",
    "publicAccess": false,
    "trackingStatus": "active",
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-03-01T14:22:00Z"
  }
]

Build docs developers (and LLMs) love

Get started for freeTalk to us