GET /enterprises/{id}/members

Get the members of an enterprise.

Servers

Path parameters

Name Type Required Description
id String Yes

ID of the Enterprise to retrieve.

Query parameters

Name Type Required Description
sortOrder String No

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

Possible values:

  • null
  • "desc"
  • "ascending"
  • "descending"
  • "asc"
count String No

SCIM-style filter.

Default value: "none"

board_fields String No

Any valid value that the nested board resource accepts.

Default value: "name"

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 below member_* args are set, the member array will be paginated.

sortBy String No

Deprecated: Please use sort instead. 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, but the API response will not contain the total available result count or pagination status data.

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.

startIndex Integer No

Any integer between 0 and 9999.

fields String No

A comma-seperated list of valid member fields.

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

organization_fields String No

Any valid value that the nested organization field resource accepts.

Default value: "displayName"

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.