List sites
List of sites that the current user has access to
Pagination
Use page[number] and page[size] parameters to paginate results:
Get first page of 10 items
GET /v1/sites?page[number]=1&page[size]=10
Get second page of 25 items
GET /v1/sites?page[number]=2&page[size]=25
The response includes pagination links and meta data:
Sorting
Use the sort parameter to sort the results:
Sort by title in ascending order
GET /v1/sites?sort=title
Sort by title in descending order
GET /v1/sites?sort=-title
Response will include sites sorted by the specified field
Sparse Fields
Use the fields[sites] parameter to request only specific attributes:
Only return title and subdomain attributes
GET /v1/sites?fields[sites]=title,subdomain
Response will only include requested fields
Filter by Title Contains
Use the filter[title_cont] parameter to find sites where the title contains specific text:
Get sites with titles containing “training”
GET /v1/sites?filter[title_cont]=training
Response will include sites with matching titles
Filter by Subdomain Contains
Use the filter[subdomain_cont] parameter to find sites where the subdomain contains specific text:
Get sites with subdomains containing “training”
GET /v1/sites?filter[subdomain_cont]=training
Response will include sites with matching subdomains
Using Multiple Parameters Together
You can combine pagination, sorting and sparse fields in a single request:
Get page 2 of sites, sorted by title descending, including only title and subdomain fields
GET /v1/sites?page[number]=2&page[size]=10&sort=-title&fields[sites]=title,subdomain
Response will include paginated sites with sparse fields
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Sort order, use: title, subdomain, for descending order use '-' e.g. &sort=-title
Number of documents
Partial attributes as specified, e.g. fields[sites]=title,subdomain
Filter by title contains, for example ?filter[title_cont]=training
Filter by subdomain contains, for example ?filter[subdomain_cont]=training