OPopenintake
Admin

Get Permission Catalog

Changed on

Every permission a role can hold, in display order. Requires staff.manage.

get/admin/permissions

Request

  • Base URL
    https://api.openintake.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.openintake.ai/admin/permissions
  • Auth
    none declared

Response

Successful Response

key'calls.view' | 'calls.recordings' | 'calls.transfer_flow' | 'intakes.view' | 'questionnaires.view' | 'intake_links.view' | 'texts.view' | 'meetings.view' | 'chats.view' | 'forms.view' | 'interviews.view' | 'email_intake.view' | 'email_intake.review' | 'call_filing.view' | 'leads.view' | 'inquiries.view' | 'cases.view' | 'outbound.manage' | 'referrals.manage' | 'negotiations.view' | 'analytics.view' | 'reports.manage' | 'transfer_metrics.view' | 'settlements.view' | 'staff.manage' | 'availability.manage' | 'settings.manage' | 'integrations.manage' | 'scoreboards.manage' | 'billing.manage' required

A capability a firm user can hold.

The value is what custom roles store, so never rename one, and don't split one in two without a data migration (see the module docstring).

labelstring required
descriptionstring required
group'Calls' | 'Intake' | 'Leads and cases' | 'Reporting' | 'Administration' required
feature_flagsstring[]

The permission is only relevant when one of these feature flags is on (empty: always relevant)

requires'calls.view' | 'calls.recordings' | 'calls.transfer_flow' | 'intakes.view' | 'questionnaires.view' | 'intake_links.view' | 'texts.view' | 'meetings.view' | 'chats.view' | 'forms.view' | 'interviews.view' | 'email_intake.view' | 'email_intake.review' | 'call_filing.view' | 'leads.view' | 'inquiries.view' | 'cases.view' | 'outbound.manage' | 'referrals.manage' | 'negotiations.view' | 'analytics.view' | 'reports.manage' | 'transfer_metrics.view' | 'settlements.view' | 'staff.manage' | 'availability.manage' | 'settings.manage' | 'integrations.manage' | 'scoreboards.manage' | 'billing.manage'

A capability a firm user can hold.

The value is what custom roles store, so never rename one, and don't split one in two without a data migration (see the module docstring).

Changes

  • ceeae5525826Revision changes
    • info

      removed the calls.feedback enum value from the / response property for the response status

    • info

      removed the calls.feedback enum value from the // response property for the response status

  • 6cf2cbf46fe1Revision changes
    • breaking

      removed the required property / from the response with the status