Skip to main content
GET
Get a document rule

Authorizations

Authorization
string
header
required

Organization-scoped bearer credential: a customer API key (1club_sk_live_...) or an MCP OAuth access token.

Path Parameters

id
integer
required

Document rule id

Response

The document rule

A document rule: which members are asked to read and accept which documents, and how.

id
integer
name
string
description
string | null
isActive
boolean
mandatoryToAccept
boolean

true: members must accept to finish setting up their account. false: optional, they may decline.

requiresTypedNameAcceptance
boolean

Members type their full name to accept. Only ever true on a mandatory rule.

requiredForEntry
boolean

An unsigned matching member cannot check themselves in. Only ever true on a mandatory rule.

The marketing channel each answer is written to. Only ever set on an optional rule.

Available options:
marketing_email,
marketing_sms,
whatsapp,
null
filters
object

Who the rule asks. Every axis means everyone when empty; a member must match every axis the rule sets.

documentIds
integer[]

The documents the rule requires, ascending.

documents
object[]
createdAt
string<date-time>
updatedAt
string<date-time>