--- title: "Search roles" method: GET path: "/roles" tags: ["Roles"] --- # Search roles `GET /roles` ## Request - Base URL: `https://api.sandbox.monite.com/v1` - URL: `https://api.sandbox.monite.com/v1/roles` - Auth: HTTP bearer Find all roles that match the search criteria. ## Query parameters - `order` 'asc' | 'desc' - `limit` integer - `pagination_token` string - `sort` 'updated_at' | 'created_at' - `id__in` string, uuid - `name` string - `created_at` string, date-time - `created_at__gt` string, date-time - `created_at__lt` string, date-time - `created_at__gte` string, date-time - `created_at__lte` string, date-time ## Headers - `x-monite-version` string, required - `x-monite-entity-id` string, required ## Response `200` Successful Response - RolePaginationResponse - `data` RoleResponse[], required: array of records - `id` string, uuid, required: UUID role ID - `created_at` string, date-time, required: UTC datetime - `updated_at` string, date-time, required: UTC datetime - `name` string, required: Role name - `permissions` BizObjectsSchemaOutput, required - `objects` RootSchemaOutput[]: List of objects - union - object - `object_type` 'accounting_tax_rate', required: Discriminator value: accounting_tax_rate - `actions` ActionSchema[]: List of actions - … - object - `object_type` 'approval_policy', required: Discriminator value: approval_policy - `actions` ActionSchema[]: List of actions - … - object - `object_type` 'approval_request', required: Discriminator value: approval_request - `actions` ActionSchema[]: List of actions - … - object - `object_type` 'comment', required: Discriminator value: comment - `actions` ActionSchema[]: List of actions - … - object - `object_type` 'cost_center', required: Discriminator value: cost_center - `actions` ActionSchema[]: List of actions - … - object - `object_type` 'counterpart', required: Discriminator value: counterpart - `actions` ActionSchema[]: List of actions - … - object - `object_type` 'counterpart_vat_id', required: Discriminator value: counterpart_vat_id - `actions` ActionSchema[]: List of actions - … - object - `object_type` 'delivery_note', required: Discriminator value: delivery_note - `actions` ActionSchema[]: List of actions - … - object - `object_type` 'entity', required: Discriminator value: entity - `actions` ActionSchema[]: List of actions - … - object - `object_type` 'entity_bank_account', required: Discriminator value: entity_bank_account - `actions` ActionSchema[]: List of actions - … - object - `object_type` 'entity_user', required: Discriminator value: entity_user - `actions` ActionSchema[]: List of actions - … - object - `object_type` 'entity_vat_ids', required: Discriminator value: entity_vat_ids - `actions` ActionSchema[]: List of actions - … - object - `object_type` 'export', required: Discriminator value: export - `actions` ActionSchema[]: List of actions - … - object - `object_type` 'ledger_account', required: Discriminator value: ledger_account - `actions` ActionSchema[]: List of actions - … - object - `object_type` 'mailbox', required: Discriminator value: mailbox - `actions` ActionSchema[]: List of actions - … - object - `object_type` 'ocr_task', required: Discriminator value: ocr_task - `actions` ActionSchema[]: List of actions - … - object - `object_type` 'onboarding', required: Discriminator value: onboarding - `actions` ActionSchema[]: List of actions - … - object - `object_type` 'overdue_reminder', required: Discriminator value: overdue_reminder - `actions` ActionSchema[]: List of actions - … - object - `object_type` 'payable', required: Discriminator value: payable - `actions` PayableActionSchema[]: List of actions - … - object - `object_type` 'payables_purchase_order', required: Discriminator value: payables_purchase_order - `actions` ActionSchema[]: List of actions - … - object - `object_type` 'payment_record', required: Discriminator value: payment_record - `actions` ActionSchema[]: List of actions - … - object - `object_type` 'payment_reminder', required: Discriminator value: payment_reminder - `actions` ActionSchema[]: List of actions - … - object - `object_type` 'person', required: Discriminator value: person - `actions` ActionSchema[]: List of actions - … - object - `object_type` 'product', required: Discriminator value: product - `actions` ActionSchema[]: List of actions - … - object - `object_type` 'project', required: Discriminator value: project - `actions` ActionSchema[]: List of actions - … - object - `object_type` 'receipt', required: Discriminator value: receipt - `actions` ActionSchema[]: List of actions - … - object - `object_type` 'receivable', required: Discriminator value: receivable - `actions` ActionSchema[]: List of actions - … - object - `object_type` 'reconciliation', required: Discriminator value: reconciliation - `actions` ActionSchema[]: List of actions - … - object - `object_type` 'role', required: Discriminator value: role - `actions` ActionSchema[]: List of actions - … - object - `object_type` 'tag', required: Discriminator value: tag - `actions` ActionSchema[]: List of actions - … - object - `object_type` 'todo_task', required: Discriminator value: todo_task - `actions` ActionSchema[]: List of actions - … - object - `object_type` 'todo_task_mute', required: Discriminator value: todo_task_mute - `actions` ActionSchema[]: List of actions - … - object - `object_type` 'transaction', required: Discriminator value: transaction - `actions` ActionSchema[]: List of actions - … - object - `object_type` 'workflow', required: Discriminator value: workflow - `actions` ActionSchema[]: List of actions - … - `status` 'active' | 'deleted', required - `next_pagination_token` string: A token that can be sent in the `pagination_token` query parameter to get the next page of results, or `null` if there is no next page (i.e. you've reached the last page). - `prev_pagination_token` string: A token that can be sent in the `pagination_token` query parameter to get the previous page of results, or `null` if there is no previous page (i.e. you've reached the first page). ## Other responses - `400`: Bad Request - `401`: Unauthorized - `403`: Forbidden - `406`: Not Acceptable - `422`: Validation Error - `500`: Internal Server Error --- [API](https://skmtc.dev/monite/apis/monite-3.md) - [All operations](https://skmtc.dev/monite/apis/monite-3/llms.txt) - [OpenAPI document](https://skmtc.dev/monite/apis/monite-3/revisions/c13be6f83ce9?raw)