List websites
/api/v2/websitesAuthorization
bearerAuth In: header
Query Parameters
Optional account to run this request against. Defaults to the account the API token is scoped to, so callers with a single account can omit it. Must be an account the authenticated user belongs to; staff may target any account. For write requests the value may be sent in the JSON body instead of the query string. The resolved account is returned on the X-Resi-Account-Id response header.
uuid1 <= value <= 20015Partial match on the name.
Only websites of this type.
Value in
- "property"
- "portfolio"
Only portfolio websites of this kind.
Value in
- "corporate"
- "centralized"
Only websites on this platform.
Value in
- "nextjs"
- "wordpress"
Only websites in this status.
Value in
- "draft"
- "live"
- "paused"
- "archived"
Exact created_at, or a range with created_at[gte], created_at[lte], created_at[gt] and created_at[lt]. Values are dates or date-times.
Exact updated_at, or a range with updated_at[gte], updated_at[lte], updated_at[gt] and updated_at[lt]. Values are dates or date-times.
Sort by any filter field; prefix with - for descending. Defaults to name.
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/api/v2/websites"{ "data": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "type": "property", "sub_mode": "corporate", "platform": "nextjs", "status": "draft", "locale": "string", "primary_domain": "string", "domains": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "hostname": "string", "is_primary": true } ], "first_published_at": "2019-08-24T14:15:22Z", "last_deployed_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" } ], "links": { "first": "string", "last": "string", "prev": "string", "next": "string" }, "meta": { "current_page": 0, "from": 0, "last_page": 0, "links": [ { "url": "string", "label": "string", "page": 0, "active": true } ], "path": "string", "per_page": 200, "to": 0, "total": 0 }}