GET /enterprises/{id}

Get an enterprise by its ID.

Servers

Path parameters

Name Type Required Description
id String Yes

ID of the enterprise to retrieve.

Query parameters

Name Type Required Description
members String No

One of: none, normal, admins, owners, all

Default value: "none"

organization_memberships String No

Comma-seperated list of: me, normal, admin, active, deactivated

Default value: "none"

member_sort String No

This parameter expects a SCIM-style sorting value prefixed by a - to sort descending. If no - is prefixed, it will be sorted ascending. Note that the members array returned will be paginated if members is 'normal' or 'admins'. Pagination can be controlled with member_startIndex, etc, but the API response will not contain the total available result count or pagination status data.

member_filter String No

Pass a SCIM-style query to filter members. This takes precedence over the all/normal/admins value of members. If any of the member_* args are set, the member array will be paginated.

Default value: "none"

member_count Integer No

0 to 100

fields String No

Comma-separated list of: id, name, displayName, prefs, ssoActivationFailed, idAdmins, idMembers (Note that the members array returned will be paginated if members is 'normal' or 'admins'. Pagination can be controlled with member_startIndex, etc, but the API response will not contain the total available result count or pagination status data. Read the SCIM documentation here for more information on filtering), idOrganizations, products, userTypes, idMembers, idOrganizations

Default value: "all"

member_fields String No

One of: avatarHash, fullName, initials, username

Default value: "avatarHash, fullName, initials, username"

member_startIndex Integer No

Any integer between 0 and 100.

organization_paid_accounts Boolean No

Whether or not to include paid account information in the returned workspace objects

Default value: false

member_sortBy String No

Deprecated: Please use member_sort. This parameter expects a SCIM-style sorting value. Note that the members array returned will be paginated if members is normal or admins. Pagination can be controlled with member_startIndex, etc, and the API response's header will contain the total count and pagination state.

Default value: "none"

organizations String No

One of: none, members, public, all

Default value: "none"

organization_fields String No

Any valid value that the nested organization field resource accepts.

Default value: "none"

member_sortOrder String No

Deprecated: Please use member_sort. One of: ascending, descending, asc, desc

Default value: "id"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.