Version 2.4.8 · latest

Site groups site-groups

Groups for organizing sites; names are unique within a tenant and a group that still contains sites cannot be deleted.

Pick an endpoint to see its example call on the right.

SitesAuthentication: User (some parameters admin only)5 endpoints

Authentication

Send the X-API-Key header (create a key on the API Keys page; the key is shown only once at creation). An Authorization: Bearer token obtained by logging in also works.

X-API-Key

Authentication failures return 401; forbidden returns 403 (code such as insufficient_scope).

Conventions

Paging uses page (from 1) and page_size; sort with sort=field or sort=-field.

Times are RFC 3339 (UTC); amounts are in cents.

Writes return 200/201/204 on success; duplicates of a unique key return 409.

GET/api/v2/site-groupsList site groups

Authentication: User (some parameters admin only)

Query parameters

FieldTypeDescription
pageinteger Page number, starting from 1
Default 1
page_sizeinteger Items per page
Default 20
sortstring Sort fields, comma-separated; prefix `-` for descending, e.g. `-created_at,id`
tenant_idinteger Admin only: filter by tenant (a malformed value returns 422). Ignored for tenant credentials, which only see their own tenant's data
idsstring Only list these IDs: comma-separated positive integers, at most 200 after deduplication (same as the page_size limit; more, or a malformed value, returns 422); an empty value is the same as omitting it. Combined with other filters as an intersection; IDs you cannot see are silently left out. Pagination is unchanged: set page_size to at least the number of IDs to get them in one page
POST/api/v2/site-groupsCreate site group

Authentication: User (some parameters admin only)

Query parameters

FieldTypeDescription
tenant_idinteger Owning tenant when an admin creates on behalf of a tenant (required); ignored for tenant callers, whose own account is always the owner.

Request body application/json

FieldTypeDescription
desstring Description
nameRequiredstring Name
GET/api/v2/site-groups/{id}Get site group

Authentication: User (some parameters admin only)

PUT/api/v2/site-groups/{id}Update site group

Authentication: User (some parameters admin only)

Request body application/json

FieldTypeDescription
desstring Description
nameRequiredstring Name
DELETE/api/v2/site-groups/{id}Delete site group

Authentication: User (some parameters admin only)

Site groups object

FieldTypeDescription
created_atstring Created at
read-only
desstring Description
idinteger Record ID
read-only
namestring Name
tenant_idinteger Owner tenant (user) ID
read-only
updated_atstring Updated at
read-only

Responses and errors

Success returns the resource JSON directly (HTTP 2xx); failures return application/problem+json (code, detail, plus errors on validation failures); lists carry items + total.

Success
{
  "id": 1,
  "name": "example"
}
List
{
  "items": [
    {
      "id": 1
    }
  ],
  "page": 1,
  "page_size": 20,
  "total": 1
}
Error
{
  "code": "validation_failed",
  "detail": "Invalid request parameters",
  "errors": [
    {
      "code": "required",
      "field": "/name",
      "message": "name is required"
    }
  ],
  "request_id": "0123456789abcdef",
  "status": 422,
  "title": "Unprocessable Entity",
  "type": "about:blank"
}
Get started

Try the live demo

Open the live demo, or contact us for a quote and the install command