Using the External ID Field

Created by Nadav Shenker, Modified on Sun, 29 Jan 2023 at 01:58 AM by Nadav Shenker

The External ID field can be used to add a reference on customer accounts to an internal system

  • Example: Customer number from PSA, CRM, accounting software, etc

This field is not visible to customers when logged into their own account.

Only parent accounts (ie. partners) can view this field for their downstream customer accounts.

To access this field over the UI:

The field is located on the Profile page.

  1. Open Account Management from the menu
  2. Select Profile
  3. Click on Manage
  4. Fill in the External ID field
  5. Click Save

To access this field over the API:

API documentation can be found :

The field can be accessed using ORGS endpoint.

GET {stack}{domain/eid}

Bulk GET requests are supported.

GET {stack}{domain/eid}/orgs

The field can be updated

PATCH {stack}{domain/eid}

Example body:

If populated, monthly billing reports include the External ID field in both the raw data and on the pivot table summary.