Skip to main content
GET
List sites

Authorizations

Authorization
string
header
required

OAuth2 client-credentials grant for operator-side integrations. Obtain an access token by POSTing client_id and client_secret to /v1/operator/oauth/token. Tokens are valid for 24 hours (86,400 seconds).

Query Parameters

page
integer
default:1

Page number (1-indexed).

Required range: x >= 1
size
integer
default:20

Results per page (max 100).

Required range: 1 <= x <= 100
status
enum<string>

Optional filter by site status.

Available options:
active,
inactive

Response

200 - application/json

Sites returned.

Standard response envelope. code is 0 on success and a non-zero application code on error (see Error Codes — §14).

code
integer
required

0 = success; otherwise an error code per the Error Codes section.

message
string
required

Human-readable description.

data
object

Endpoint-specific payload.