Overview

A user represents a person who can access a Qomon space. User records include personal information such as:

{
  "firstname": "John",
  "surname": "Doe",
  "mail": "john.doe@example.com",
  "mobile": "0123456789",
  "address": {
    "housenumber": "123",
    "street": "Rue de la paix",
    "city": "Paris",
    "country": "France"
  }
}

They also include Qomon-specific attributes such as:

{
  "role": "superadmin",
  "status": ["available week-end", "available night"]
}

The space is determined by the token you use to authenticate the request.

Roles

A role defines what a user can access and do in a Qomon space. Each user has exactly one role.

Enum value	Display name	Scope
`superadmin`	Administrator	Full access, including platform settings and subscription management. Mandatory role — cannot be deleted.
`admin`	Staff	Full access except platform settings, subscription management, and contact exports. Designed for staff or headquarters users.
`manager`	Organizer	Limited access to actions, petitions, and teams. No access to the contact database. Designed for field and digital organizers.
`user`	Champ	Mobile-app access for field actions. Assigned by default to new users.
`custom`	Custom	Permissions defined by your organization’s admin. Available on Expert plans only.

You can manage role permissions and create custom roles only in the Qomon UI, under Space Settings > General > Role Management. These actions are not available through the API.

Tip — retrieving role IDs: Use GET /roles to list the roles available in the current space and retrieve their role_id values before calling PATCH /users/role. For more details about Qomon’s default roles and permissions, see the Qomon Help Center article about roles.

Permissions (`access` field)

Each role returned by GET /roles includes an access array: the permissions actually granted to that role, as resource:scope strings.

{
  "id": 12,
  "name": "Field organizer",
  "type": "custom",
  "access": ["members:read", "members:write", "sanction:write"]
}

A role only lists the scopes it was granted, so access can be empty (e.g. for the default user role) or contain only some of a resource’s scopes.

Role permissions are managed in the Qomon UI under Space Settings > General > Role Management. access is read-only in the API.

What each permission grants

A resource:scope entry is made of the resource being permissioned and the level of access granted on it (see scope meanings below). Browse by category:

Contacts & members

Resource	Grants access to
`contacts`	The contact database: viewing and editing contact records. Base permission for most contact-related actions below.
`contacts.list`	Saved contact lists / segments.
`contacts.massive`	Bulk update or bulk delete of contacts.
`contacts.duplicates`	Duplicate contact detection and merging.
`contacts.private_interactions`	Private interactions on a contact’s timeline.
`contacts.locked_fields`	Configuring which contact fields are locked for edition.
`contacts.hidden_web_fields`	Viewing which contact fields are hidden on the web app.
`contacts.transfer`	Transferring contacts between teams or organizers.
`export`	Exporting contacts (CSV/XLSX).
`import`	Importing contacts.
`import_mobile`	Importing contacts from the mobile app.
`members`	The space’s member (user) list.
`members.invitation`	Inviting new members to the space.
`members.notification`	Sending notifications to members.
`members.teams`	Team membership management.

Actions & field organizing

Resource	Grants access to
`action`	Actions/events created by every user in the space.
`action_own`	Actions/events the caller created themselves. Gates the whole Actions section — required even to view actions created by others via `action`.
`action_bar`	The Qomon AI action bar.
`task`	Tasks.
`documents`	Documents.
`workflows`	Workflows (automations) created by every user.
`workflows_own`	Workflows the caller created themselves.
`petition`	Publishing petitions.
`online_form`	Online forms.
`survey`	Survey results and survey building.

Communication

Resource	Grants access to
`communication`	The communication module as a whole. Base permission for the entries below.
`communication.email`	Email campaigns created by every user.
`communication.email_own`	Email campaigns restricted to ones the caller created. Only takes effect when `communication.email` isn’t granted — it’s a fallback, not additive.
`comm.email.ignore_consents`	Sending emails while bypassing recipient consent restrictions.
`communication.sms`	SMS campaigns.
`communication.sender`	Sender identities (email/SMS senders).
`communication.deliverability_center`	The deliverability center (bounce/complaint monitoring).

Donations & transactions

Resource	Grants access to
`online_donation`	Online donation forms.
`membership`	Membership status and dues.
`transaction`	Individual donation/membership transactions.
`transaction_all`	Transactions across the whole space, not just the caller’s own.
`transaction_export`	Exporting transactions.
`transaction_dashboard`	The transactions dashboard/analytics.
`reopen_batch`	Reopening a closed remittance batch.
`sanction`	Sanctions (payment holds/blocks) on contacts.
`mandate`	SEPA mandates.

Analytics & settings

Resource	Grants access to
`dashboard`	The analytics dashboard.
`data_insight`	The cartography data-insights layer.
`carto.turf`	Custom cartography border/turf layers.
`settings`	The space settings module as a whole. Base permission for the entries below.
`settings.roles`	Roles and permissions management.
`settings.billing`	Billing and subscription management.
`settings.connect`	Connect (third-party integrations) management.
`settings.connect.apikeys`	Connect API keys management.
`stgs.consent.restricted`	Restricted consent settings.

What a scope means

The part after the colon is the level of access granted on the resource:

Scope	Meaning
`read`	Can view the resource.
`write`	Can create or edit the resource.
`delete`	Can delete the resource.
`create`	Can create new items.
`update`	Can bulk-update items.
`publish`	Can publish (e.g. petitions, workflows).
`min`	Minimal/summary-only access.
`self` / `all`	Scoped to the caller’s own records (`self`) vs. every record in the space (`all`).
`invite`	Can send invitations.
`notify`	Can send notifications.

Teams

Use teams to organize members of your Qomon space for actions and field organizing. Each team has its own visibility settings.

Public vs private teams

Public teams are visible to every member of the space and can be returned by GET /teams/public.
Private teams are only visible to members who belong to that team or have the superadmin role.

PATCH /teams/{id} performs a full replacement. It does not partially merge fields.

Contacts

Search

Actions

Fundraising

Users

Interactions

Notes

Roles

Permissions (`access` field)

What each permission grants

What a scope means

Teams

Public vs private teams

​Roles

​Permissions (access field)

​What each permission grants

​What a scope means

​Teams

​Public vs private teams

Roles

Permissions (`access` field)

What each permission grants

What a scope means

Teams

Public vs private teams