For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

revvue.ai Log in

Docs API Reference

Docs API Reference

Auth & tenants
Companies & locations
Inbox
Reviews
Bookings
Surveys
QR codes, vouchers & rewards
Analytics & reports
Jonna (AI agent)
Knowledge base
Live chat
Embeds
Notifications & channels
Content & templates
Integrations
File storage
Platform documents & settings
Service internals

revvue.ai Log in

Auth & tenants Queries

roles

||View as Markdown|

Example Query

query ExampleQuery($clientId: String, $roleNames: [String], $id: String, $name: String, $compositeClientRoleNames: [String], $delete: Boolean) {
  roles(clientId: $clientId, roleNames: $roleNames, id: $id, name: $name, compositeClientRoleNames: $compositeClientRoleNames, delete: $delete) {
    id
    name
    compositeClientRoleNames
    delete
  }
}

Variables

{
  "clientId": "revvue-revvue-client",
  "roleNames": [
    "example"
  ],
  "id": "example",
  "name": "example",
  "compositeClientRoleNames": [
    "example"
  ],
  "delete": false
}

Example response

{
  "data": {
    "roles": [
      {
        "id": "example",
        "name": "example",
        "compositeClientRoleNames": [
          "example"
        ],
        "delete": true
      }
    ]
  }
}

Was this page helpful?

Arguments

clientIdStringOptional

roleNameslist of optional StringsOptional

idStringOptional

nameStringOptional

compositeClientRoleNameslist of optional StringsOptional

deleteBooleanOptional

Returns

an optional list of optional Role

idStringOptional

Role id.

nameStringOptional

Role name.

compositeClientRoleNameslist of optional StringsOptional

Composite client role names.

deleteBooleanOptional

Role delete.