Skip to content

Register an API application

LiveFor: Admin, developerAccess: Admin, developer

Create credentials and choose scopes.

An API application lets one of your own systems reach your firm’s contacts, work, time, invoices and colleagues through the REST API, within the scopes you give it.

  1. Go to Settings > Connected Apps > API Applications and press Register Application.

  2. Enter the Application Name and tick its Scopes, such as Read contacts or Create and update work items.

  3. Press Register.

  4. Open it with Manage and issue its credentials: an Authorization token and an Access key.

The Register Application dialog with an Application Name and Scopes such as Read contacts, Create and update contacts, Read work items, Read time entries, Read invoices, Read colleagues, Add colleagues and Manage webhook subscriptions.
Register Application.

On Manage you can also Rotate Access Key or Rotate Authorization Token, add webhook subscriptions, read the Delivery Log, or Revoke Application. Revoking stops both credentials at once and cannot be undone.

API Applications with Register Application, a registered application with 9 of 9 scopes and No credentials, and an Invoice sync status table.
API Applications.

Still need help?

Ask your firm's BMS admin first: they can see your access level and your firm's settings. Clients of a firm should contact their accountant.

Last updated: