Firm roles

List firm roles

Changed on Nov 3, 2026

The roles this firm has defined, such as Partner or Preparer. Use the ids with POST /entities/{entity_id}/firm_role_assignments.

get/firm_roles

Request

Base URL
https://api.soraban.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/soraban/apis/soraban-private-api/docs/firm_roles/get.ts
A function with typed inputs. Its response is checked against the schema.

Response

The firm's roles.

idinteger

role_namestring nullable

firm_idinteger

is_default_contactboolean nullable

permission_idsinteger[]

notification_type_idsinteger[]

created_atstring date-time

updated_atstring date-time

Changes

Nov 3, 20261c230fa547ad Revision changes
- breaking
  the response property / became nullable for the status
- breaking
  the response property became optional for the status
- breaking
  the response property / became optional for the status
- warning
  deleted the header request parameter ngrok-skip-browser-warning
- info
  api operation id listFirmRoles was added
- info
  the endpoint scheme security bearerAuth was removed from the API
- info
  api tag Firm roles added
- info
  removed the non-success response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status

Operation history