List sites
Sites of the account that the API key or access token can open, in ascending order of id; order=newest gives the latest first. Call it first: almost every other operation takes a site_id from here. Each site comes with its name, address, time zone, whether it is suspended and whether the Getsitecontrol script was found on it. Deleted sites are not listed. To find a site by its name or address, pass part of it as search.
A page holds up to limit sites; while next_cursor is set, pass it as cursor for the next page.
Request
- Base URLhttps://api.getsitecontrol.com
- AuthHTTP bearer
Query parameters
Part of the site name or URL, any case, e.g. shop or example.com; only matching sites are listed. Omit for all
next_cursor of the previous page, sent with the same order; omit for the first
Items per page
Comma-separated fields to keep in each item, for example id,name; each item then carries only those fields and id. Omit for every field
Order of a list. oldest: the oldest item first; newest: the newest item first, for the latest items without paging through the history.
Order of the items: oldest first (default) or newest first; asc and desc mean the same
Response
Successful Response
Example response
{
"items": [
{
"access": {
"widgets": "edit",
"emails": "edit",
"contacts": "view"
}
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.