Skip to main content
GET
Search CoworkerLegalContentAudits
A CoworkerLegalContentAudit records when a customer accepted a specific version of a legal document at a location. Each record captures the type of legal content accepted (e.g. general terms, privacy policy, or plan-specific terms) along with the unique version identifier that was in effect at the time of acceptance. Use these records to demonstrate compliance and to determine exactly which version of a document a customer agreed to. For tariff-specific terms (LegalContentType = TariffTerms), TariffUniqueId identifies the pricing plan whose terms were accepted. LegalContentAuditUniqueId identifies the precise version of the document that was shown to and accepted by the customer.

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 CoworkerLegalContentAudit-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 customer who accepted the legal content.
Filter by iD of the location where the legal content was accepted.
Filter by name of the legal content document that was accepted.
Filter by type of legal document accepted: GeneralTerms, VisitorTerms, CheckoutTerms, PrivacyPolicy, CookiesPolicy, or TariffTerms.
Filter by unique identifier of the pricing plan whose terms were accepted; only set when LegalContentType is TariffTerms.
Filter by unique identifier of the specific version of the legal document that was in effect and accepted by the customer at the time of acceptance.

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

CoworkerLegalContentAudit[]
The list of CoworkerLegalContentAudit records matching the query. See the Get one CoworkerLegalContentAudit 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