Overview - Qomon API Hub

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.

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.

​Roles

​Teams

​Public vs private teams

Roles

Teams

Public vs private teams