Users
A user is a member of your organisation with a login and a set of permissions. The API lets you manage staff accounts programmatically. See User Management for the full picture.
Methods
Section titled “Methods”Retrieve Single User
Section titled “Retrieve Single User”/backend/api/v1/users/ID - fetch the user with the specified ID.
List Users
Section titled “List Users”/backend/api/v1/users/ - list all users.
Additional Query Parameters
Section titled “Additional Query Parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
idAfter | integer | No | Only include users with a higher ID |
createdSince | datetime | No | Only include users created since the given time |
updatedSince | datetime | No | Only include users updated since the given time |
/backend/api/v1/users/ - add a new user. The newly-added user will be returned.
/backend/api/v1/users/ID - update the user with the specified ID. The modified user will be returned.
DELETE
Section titled “DELETE”/backend/api/v1/users/ID - delete the user with the specified ID.
Fields
Section titled “Fields”| Field | Name | Type | Description |
|---|---|---|---|
| name | Name | Text | Full name of the user |
| login | Login | Text | Username for logging into the system |
| Email Address | Text | Primary email address for the user | |
| status | User Status | Preset Value(s) | Array of status names currently active for this user |
| access | Allow Access | Preset Value(s) | Array of access flag names granted to this user |
| privilegeLevel | Privilege Level | Preset Value | Privilege level name for this user |
| expertLevel | Expert Level | Preset Value | Expert level name for this user |
| userGroups | Grant Permissions | Preset Value(s) | Array of user group names this user belongs to |
| departments | Departments | Preset Value(s) | Array of department names the user belongs to |
| commissionReferenceDate | Commission Reference Date | Date | Reference date for commission calculations |
| commissionAnnualTarget | Commission Annual Target | Currency | Total annual commission target amount |
| commissionAnnualTargetOneOff | Commission Annual Target (One-Off Charges) | Currency | Annual commission target for one-off charges |
| commissionAnnualTargetRecurring | Commission Annual Target (Recurring Charges) | Currency | Annual commission target for recurring charges |
| commissionAnnualTargetCalls | Commission Annual Target (Call Charges) | Currency | Annual commission target for call charges |
| connectionChargeCommissionProfile | One-Off Commission Profile | Preset Value | Commission profile name for one-off charges |
| serviceChargeCommissionProfile | Recurring Commission Profile | Preset Value | Commission profile name for recurring charges |
| callChargeCommissionProfile | Call Commission Profile | Preset Value | Commission profile name for call charges |
| commissionPaid | Commission Paid | Currency | Total commission paid to this user |
| permissionBillingMain | Billing | Preset Value(s) | Array of permission level names for billing functions |
| permissionReports | Reports | Preset Value(s) | Array of permission level names for reports access |
| permissionCustomers | Customers | Preset Value(s) | Array of permission level names for customer management |
| permissionDirectDebits | Direct Debits | Preset Value(s) | Array of permission level names for direct debit management |
| permissionNumbers | Numbers | Preset Value(s) | Array of permission level names for number management |
| permissionFeatures | Features | Preset Value(s) | Array of permission level names for feature management |
| permissionInvoices | Invoices | Preset Value(s) | Array of permission level names for invoice management |
| permissionPayments | Payments | Preset Value(s) | Array of permission level names for payment management |
| permissionTransactions | Transactions | Preset Value(s) | Array of permission level names for transaction management |
| permissionCorrespondence | Correspondence | Preset Value(s) | Array of permission level names for correspondence management |
| permissionNotes | Notes | Preset Value(s) | Array of permission level names for notes management |
| permissionTariffs | Tariffs | Preset Value(s) | Array of permission level names for tariff management |
| permissionDiscountPlans | Discount Plans | Preset Value(s) | Array of permission level names for discount plan management |
| permissionUsers | Users | Preset Value(s) | Array of permission level names for user management |
| permissionCallOverrides | Call Overrides | Preset Value(s) | Array of permission level names for call override management |
| permissionGeneratedCDRs | Generated CDRs | Preset Value(s) | Array of permission level names for generated CDR management |
| permissionParameters | Parameters | Preset Value(s) | Array of permission level names for system parameter management |
| permissionBulkImportFiles | Bulk Import Files | Preset Value(s) | Array of permission level names for bulk import file management |
| permissionImageFiles | Image Files | Preset Value(s) | Array of permission level names for image file management |
| permissionCarrierTransactions | Carrier Transactions | Preset Value(s) | Array of permission level names for carrier transaction management |
| permissionFixedFeeTariffs | Fixed Fee Tariffs | Preset Value(s) | Array of permission level names for fixed fee tariff management |
| permissionSentEmails | Sent Emails | Preset Value(s) | Array of permission level names for sent email management |
| permissionPaymentCards | Payment Cards | Preset Value(s) | Array of permission level names for payment card management |
| permissionPaymentCardPayments | Payment Card Payments | Preset Value(s) | Array of permission level names for payment card payments management |
| permissionPaymentCardRuns | Payment Card Runs | Preset Value(s) | Array of permission level names for payment card run management |
| permissionDirectDebitPayments | Direct Debit Payments | Preset Value(s) | Array of permission level names for direct debit payments management |
| permissionDirectDebitRuns | Direct Debit Runs | Preset Value(s) | Array of permission level names for direct debit run management |
| permissionTickets | Tickets | Preset Value(s) | Array of permission level names for ticket management |
| permissionCustomerContacts | Customer Contacts | Preset Value(s) | Array of permission level names for customer contact management |
| permissionFeatureDiscountSchemes | Feature Discount Schemes | Preset Value(s) | Array of permission level names for feature discount scheme management |
| permissionEmailAddresses | Email Addresses | Preset Value(s) | Array of permission level names for email address management |
| permissionCustomerActivity | Customer Activity | Preset Value(s) | Array of permission level names for customer activity viewing |
| permissionUserActivity | User Activity | Preset Value(s) | Array of permission level names for user activity viewing |
| permissionIgnoreTrafficNumbers | Ignore Traffic Numbers | Preset Value(s) | Array of permission level names for ignore traffic number management |
| permissionIgnoreTrafficChargebands | Ignore Traffic Chargebands | Preset Value(s) | Array of permission level names for ignore traffic chargeband management |
| permissionXeroTasks | Xero Tasks | Preset Value(s) | Array of permission level names for Xero task management |
| permissionExpectedPayments | Expected Payments | Preset Value(s) | Array of permission level names for expected payment management |
| permissionBillingTasks | Billing Tasks | Preset Value(s) | Array of permission level names for billing task management |
| permissionDisasterRecoveryFiles | Disaster Recovery Files | Preset Value(s) | Array of permission level names for disaster recovery file management |
| permissionTODOs | TODOs | Preset Value(s) | Array of permission level names for TODO management |
| permissionServices | Services | Preset Value(s) | Array of permission level names for service management |
| permissionSettingsStandardFeatures | Standard Features | Preset Value(s) | Array of permission level names for standard feature management |
| permissionSettingsFeatureTypes | Feature Types | Preset Value(s) | Array of permission level names for feature type management |
| permissionSettingsTransactionTypes | Transaction Types | Preset Value(s) | Array of permission level names for transaction type management |
| permissionSettingsServiceChargeIntervals | Service Charge Intervals | Preset Value(s) | Array of permission level names for service charge interval management |
| permissionSettingsCallTypes | Call Types | Preset Value(s) | Array of permission level names for call type management |
| permissionSettingsCarrierCallTypes | Carrier Call Types | Preset Value(s) | Array of permission level names for carrier call type management |
| permissionSettingsCallTypesAKA | Call Types AKA | Preset Value(s) | Array of permission level names for call type AKA management |
| permissionSettingsChargebandDiscrepancies | Chargeband Discrepancies | Preset Value(s) | Array of permission level names for chargeband discrepancy management |
| permissionSettingsCustomerStatuses | Customer Statuses | Preset Value(s) | Array of permission level names for customer status management |
| permissionSettingsNumberStatuses | Number Statuses | Preset Value(s) | Array of permission level names for number status management |
| permissionSettingsFeatureStatuses | Feature Statuses | Preset Value(s) | Array of permission level names for feature status management |
| permissionSettingsPaymentTypes | Payment Types | Preset Value(s) | Array of permission level names for payment type management |
| permissionSettingsNumberTypes | Number Types | Preset Value(s) | Array of permission level names for number type management |
| permissionSettingsCustomerGroups | Customer Groups | Preset Value(s) | Array of permission level names for customer group management |
| permissionSettingsUserGroups | User Groups | Preset Value(s) | Array of permission level names for user group management |
| permissionSettingsDepartments | Departments | Preset Value(s) | Array of permission level names for department management |
| permissionSettingsNoteTypes | Note Types | Preset Value(s) | Array of permission level names for note type management |
| permissionSettingsTicketTypes | Ticket Types | Preset Value(s) | Array of permission level names for ticket type management |
| permissionSettingsTicketStatuses | Ticket Statuses | Preset Value(s) | Array of permission level names for ticket status management |
| permissionSettingsTicketPriorities | Ticket Priorities | Preset Value(s) | Array of permission level names for ticket priority management |
| permissionSettingsTicketActivityTypes | Ticket Activity Types | Preset Value(s) | Array of permission level names for ticket activity type management |
| permissionSettingsTicketSuppliers | Ticket Suppliers | Preset Value(s) | Array of permission level names for ticket supplier management |
| permissionSettingsTicketResponses | Ticket Responses | Preset Value(s) | Array of permission level names for ticket response management |
| permissionSettingsCommissionProfiles | Commission Profiles | Preset Value(s) | Array of permission level names for commission profile management |
| permissionSettingsCarrierTransactionTypes | Carrier Transaction Types | Preset Value(s) | Array of permission level names for carrier transaction type management |
| permissionSettingsVATRates | VAT Rates | Preset Value(s) | Array of permission level names for VAT rate management |
| permissionSettingsCustomerProducts | Customer Products | Preset Value(s) | Array of permission level names for customer product management |
| permissionSettingsCorrespondenceTypes | Correspondence Types | Preset Value(s) | Array of permission level names for correspondence type management |
| permissionSettingsUserActivityReasons | User Activity Reasons | Preset Value(s) | Array of permission level names for user activity reason management |
| permissionSettingsCallTypeCustomGroups | Call Type Custom Groups | Preset Value(s) | Array of permission level names for call type custom group management |
| permissionSettingsLocations | Locations | Preset Value(s) | Array of permission level names for location management |
| permissionSettingsIgnoreTrafficNumberTypes | Ignore Traffic Number Types | Preset Value(s) | Array of permission level names for ignore traffic number type management |
| permissionSettingsIgnoreTrafficChargebandTypes | Ignore Traffic Chargeband Types | Preset Value(s) | Array of permission level names for ignore traffic chargeband type management |
| permissionSettingsUserActivityTypes | User Activity Types | Preset Value(s) | Array of permission level names for user activity type management |
| permissionSettingsInvoiceUsageReportCustomerProfiles | Invoice Usage Report Customer Profiles | Preset Value(s) | Array of permission level names for invoice usage report customer profile management |
| permissionSettingsMyAccountCustomerProfiles | MyAccount Customer Profiles | Preset Value(s) | Array of permission level names for MyAccount customer profile management |
| permissionSettingsMyAccountNumbers | MyAccount Numbers | Preset Value(s) | Array of permission level names for MyAccount number management |
| permissionSettingsMyAccountCampaigns | MyAccount Campaigns | Preset Value(s) | Array of permission level names for MyAccount campaign management |
| permissionSettingsXeroTaskTypes | Xero Task Types | Preset Value(s) | Array of permission level names for Xero task type management |
| permissionSettingsExpectedPaymentTypes | Expected Payment Types | Preset Value(s) | Array of permission level names for expected payment type management |
| permissionSettingsCustomerClasses | Customer Classes | Preset Value(s) | Array of permission level names for customer class management |
| permissionSettingsCarriers | Carriers | Preset Value(s) | Array of permission level names for carrier management |
| permissionSettingsBillingTaskTypes | Billing Task Types | Preset Value(s) | Array of permission level names for billing task type management |
| permissionSettingsStoredFilesProviderTypes | Stored Files Provider Types | Preset Value(s) | Array of permission level names for stored files provider type management |
| permissionSettingsStoredFilesProviders | Stored Files Providers | Preset Value(s) | Array of permission level names for stored files provider management |
| permissionSettingsAutoTopupProfiles | Auto Topup Profiles | Preset Value(s) | Array of permission level names for Auto Topup profile management |
| permissionSettingsTODOStatuses | TODO Statuses | Preset Value(s) | Array of permission level names for TODO status management |
| permissionSettingsTODOActivityTypes | TODO Activity Types | Preset Value(s) | Array of permission level names for TODO activity type management |
| permissionSettingsTODORepeatRules | TODO Repeat Rules | Preset Value(s) | Array of permission level names for TODO repeat rule management |
| permissionSettingsTODOSuggestions | TODO Action Taken/Next Steps | Preset Value(s) | Array of permission level names for TODO action/suggestion management |
| permissionSettingsTODOTypes | TODO Types | Preset Value(s) | Array of permission level names for TODO Type management |
| permissionSettingsServiceStatuses | Service Statuses | Preset Value(s) | Array of permission level names for service status management |
| permissionSettingsServiceTypes | Service Types | Preset Value(s) | Array of permission level names for service type management |
| permissionBillingBillingRun | Billing Run | Preset Value(s) | Array of permission level names for billing run operations |
| permissionBillingProcessing | Processing | Preset Value(s) | Array of permission level names for billing processing operations |
| permissionBillingDirectDebits | Direct Debits | Preset Value(s) | Array of permission level names for direct debit operations |
| permissionBillingCalls | Calls | Preset Value(s) | Array of permission level names for call-related billing operations |
| permissionBillingBillingRuns | Billing Runs | Preset Value(s) | Array of permission level names for billing run management |
| permissionBillingBillingCycles | Billing Cycles | Preset Value(s) | Array of permission level names for billing cycle management |
| permissionBillingCDRFiles | CDR Files | Preset Value(s) | Array of permission level names for CDR file management |
| permissionBillingDeletedCalls | Deleted Calls | Preset Value(s) | Array of permission level names for deleted call management |
| permissionDataProtectionResponsibilities | Data Protection Responsibilities | Preset Value(s) | |
| permissionDataProtectionUserActivity | User Activity | Preset Value(s) | |
| permissionDataProtectionCustomerActivity | Customer Activity | Preset Value(s) | |
| permissionDataProtectionAccess | Data Protection Access | Preset Value(s) | |
| id | User ID | Text | The unique identifier for this user |
| isSystemUser | System User | Text | Indicates whether this is a system user account |