Sign in

v1

latestOpenAPI 3.0.12026-07-24310590875.6 KB
partner

Get user role details

Get details about an existing user role in a BILL organization.

This operation requires partner-level permissions.

  • A sessionId header value generated with API partner login
  • An appKey header value
  • The organizationId of the organization
get/v3/partner/roles/{roleId}

Path parameters

roleIdstring required

BILL-generated ID of the user role. The value begins with 0po.

Example:{{partner_user_role_id}}

Headers

sessionIdstring nullable

API session ID generated with /v3/partner/login

Example:{{partner_session_id}}
appKeystring nullable

Application key sent to you by BILL when you create a partner account

Example:{{app_key}}
organizationIdstring nullable

BILL-generated ID of the organization

Example:{{partner_organization_id}}

Response

Get user role details response

idstring

BILL-generated ID of the user role. The value begins with 0po.

type'ADMINISTRATOR' | 'CLERK' | 'APPROVER' | 'ACCOUNTANT' | 'CUSTOM' | 'PAYER' | 'PARTNER' | 'AUDITOR' | 'NO_ACCESS' | 'MEMBER' | 'MEMBER_PLUS' | 'INTERNAL' | 'PURCHASE_REQUESTER' | 'CONSOLE_CUSTOM' | 'RECEIVER' | 'PROCUREMENT_USER' | 'UNDEFINED'

User role type.

descriptionstring

User role description

createdTimestring date-time

Created date and time

updatedTimestring date-time

Updated date and time