Find a guide, feature, or API endpoint. Try “FTP”, “alerts”, or “instruments”.

Browse documentation

Docs/API reference / Sites

List sites

Requires `developer_api.sites.list` on the project-scoped Developer API connection. Use the API origin supplied for your deployment. Unknown query parameters and unexpected request bodies are rejected.

GET/dev-api/v1/p/{project_id}/sitesAll endpoints ↗

The request panel saves credentials and API settings in this browser. Privacy details

GET
/dev-api/v1/p/{project_id}/sites

Authorization

developerApiKey
AuthorizationBearer <token>

Project-scoped Developer API connection key. Grant only the required operation permissions.

In: header

Path Parameters

project_id*string
Match.*\S.*
Length1 <= length <= 128

Query Parameters

q?string

Search text.

Lengthlength <= 256
include_archived?boolean

Include archived resources explicitly. Archived history still requires authorization.

Defaultfalse
limit?integer

Maximum entries to return. Defaults shown are repository defaults; deployed limits may differ.

Range1 <= value <= 100
Default50
cursor?string

Opaque cursor from next_cursor. Keep all filters, resource scope, time range, order, and authorization context unchanged.

Length1 <= length <= 16384

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

bash
curl -X GET "https://example.com/dev-api/v1/p/string/sites"
json
{
  "request_id": "string",
  "data": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "next_cursor": "string"
}