v1

latestOpenAPI 3.0.32026-07-24614422630.2 KB

Users

Get user by Id

Returns a specific user by Id

get/users/{id}

Path parameters

idstring required

Response

successful operation

idstring

displayNamestring

titlestring

emailstring

phoneNumberstring

state'ACTIVE' | 'DISABLED' | 'EXPIRED'

role'ADMIN' | 'FINANCE' | 'SALES' | 'SALES_MANAGER' | 'ACCOUNTANT' | 'BILLING_CLERK' | 'REVENUE_CLERK' | 'READ_ONLY' | 'EXECUTIVE' | 'CRM' | 'IMPORT' | 'BILLY_ADMIN' | 'BILLY_ENGINEER' | 'BILLY_SUPPORT' | 'BILLY_JOB'

ssoOnlyboolean

tenantNamestring

cognitoUserStatus'UNCONFIRMED' | 'CONFIRMED' | 'ARCHIVED' | 'COMPROMISED' | 'UNKNOWN' | 'RESET_REQUIRED' | 'FORCE_CHANGE_PASSWORD' | 'EXTERNAL_PROVIDER' | 'UNKNOWN_TO_SDK_VERSION'

hasAllEntitiesAccessboolean

entityIdsstring[]

externalIdstring

eventObjectIdstring