Skip to main content
GET
Search LegalContentAudits
A LegalContentAudit is a read-only version history of legal content for a location, including general, checkout, visitor, privacy, cookie, and plan terms.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the LegalContentAudit-List role.

Enums

Query Parameters

Pagination & Sorting

integer
default:"1"
The page number to retrieve.
integer
default:"25"
The number of records per page.
string
The property name to sort results by (e.g. Name, CreatedOn).
integer
Sort direction. 0 for ascending, 1 for descending.

Filters

Filter by iD of the location whose legal content version is recorded..
Filter by display value for Business.Name..
Filter by system-generated version label using the next version number and the location-local creation date..
Filter by snapshot of the legal content text when this version was created..
Filter by user name or system account recorded as creating this legal content version..
Filter by unique ID of the plan whose terms this version snapshots; null for location-wide legal content..
Filter by type of legal content snapshot: GeneralTerms, VisitorTerms, CheckoutTerms, PrivacyPolicy, CookiesPolicy, or TariffTerms..

Range Filters

Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.
Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.
Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.
Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

Filtering by Name

Range filters

Response

200

LegalContentAudit[]
The list of LegalContentAudit records matching the query. See the Get one LegalContentAudit endpoint for the full list of properties returned for each record.
integer
Current page number.
integer
Number of records per page.
string
The field used for sorting.
integer
The sort direction (0 = ascending, 1 = descending).
integer
Index of the first item on the current page.
integer
Index of the last item on the current page.
integer
Total number of matching records across all pages.
integer
Total number of pages.
boolean
Whether there is a next page of results.
boolean
Whether there is a previous page of results.
Example Response