Skip to main content
An agreement is a document a visitor reads and signs on the way in: an NDA, a safety instruction, a video to watch.

Path parameters

string
required
The location.

Query parameters

boolean
true returns only the agreements currently presented to visitors.
string
default:"en"
Language for the texts.

Response

A plain array in presentation order. Deleted and archived agreements are left out.
string
The agreement id.
string
Internal name, as shown in the Backoffice.
boolean
Whether it is currently presented.
string
text, pdf or video.
object
The text, keyed by language code.
string[]
Visit type ids this agreement applies to.
number
Bumped when the content changes, so you can tell which version a visitor signed.
number
Order in which agreements are presented.
number
How long a signature stays valid before a returning visitor signs again.
boolean
Only presented to the person signing in a group.
cURL