sites

Get all sites in an organization. Every member can look up every site; filter with hasAccess="true" to narrow to the sites the calling user can work with on boards, or boardId to narrow to the sites they can work with on that board. Each row carries the boolean hasAccess. Use with filters and pagination to narrow the results.

post/api/rpc/querySites

Request

  • Base URL: https://21risk.com
  • URL: https://21risk.com/api/rpc/querySites
  • Auth: OAuth 2 (client credentials, token URL /api/v1/oauth/token)

Request body

tenantunknown required
querystring
namestring

Operands must be strings. Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty. Use the facet query to discover valid values.

countrystring

Operands must be strings. Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty. Use the facet query to discover valid values.

citystring

Operands must be strings. Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty. Use the facet query to discover valid values.

regionstring

Operands must be strings. Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty. Use the facet query to discover valid values.

districtstring

Operands must be strings. Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty. Use the facet query to discover valid values.

postcodestring

Operands must be strings. Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty. Use the facet query to discover valid values.

localitystring

Operands must be strings. Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty. Use the facet query to discover valid values.

neighborhoodstring

Operands must be strings. Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty. Use the facet query to discover valid values.

tagsstring

Operands must be strings. Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty. Use the facet query to discover valid values.

insurancestring

Operands must be true or false, such as "true" or "!false". Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty.

statusstring

Valid operands: active, inactive. Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty.

groupsstring

Operands must represent integer IDs, such as "1,2" or "!3". Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty.

parentstring

Operands must be strings. Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty. Use the facet query to discover valid values.

hasAccessstring

Operands must be true or false, such as "true" or "!false". Comma-separated values for OR, semicolon for AND. Use ! to exclude, ^ for exact match, * for any value, !* for empty.

createdDatestring

ISO dates (2024-01-15), periods (2024, 2024-01), comparisons (>=2024, <2024-06), ranges (2024-01-01..2024-12-31), or relative dates (@today, @today-7d). Units: d, w, m, y. Use * for any date, !* for empty.

includesstring[]

Only include records whose IDs are in this list.

excludesstring[]

Exclude records whose IDs are in this list.

afterstring

Cursor-based pagination: return results after this cursor. Use pageInfo.endCursor from the previous page.

beforestring

Cursor-based pagination: return results before this cursor. Use pageInfo.startCursor from the current/previous page.

lastinteger

Cursor-based pagination: number of results to return before the before cursor. Use for backward pagination.

sort'name' | 'country' | 'address' | 'city' | 'region' | 'district' | 'postcode' | 'locality' | 'neighborhood' | 'street' | 'latitude' | 'longitude' | 'createdDate' | 'status' | 'parent'
direction'asc' | 'desc'

Response

Successful response

Changes

No recorded changes to this operation across all 2 revisions of this API.