Skip to navigation

Get group access settings

View as Markdown

Returns your organization’s group access settings. There is one per organization, so there is no id.

Authentication

AuthorizationBearer

JWT bearer token authentication. Include the Configuration API key in the Authorization header as ‘Bearer <token>’.

Response

Your organization's group access settings
hide_details_enabledbooleanOptional

If true, group details are hidden from the user after a successful add (e.g. ‘you can now receive emails from group_name@org.com’).

dl_group_validation_benderobjectOptional
Data mapping that validates and preprocesses the group email a user provides, for example adding a prefix or changing the domain. Replaced as a whole on update.
updated_timedatetimeOptionalRead-only
When the configuration was last updated.
updated_bystringOptionalRead-only
Who last updated the configuration.
versionobjectOptional
Document version. On update, send back the num from your last read.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error