BEbenchling
organizations

List organizations

Returns all organizations that the caller has permission to view. The following roles have view permission:

  • tenant admins
  • members of the organization
get/organizations

Request

  • Base URL
    https://{tenant_name}.benchling.com/api/v2
  • Auth
    HTTP bearer

Query parameters

idsstring

Comma-separated list of ids. Matches all of the provided IDs, or returns a 400 error that includes a list of which IDs are invalid.

namestring

Name of an organization. Restricts results to those with the specified name.

nameIncludesstring

Name substring of an organization. Restricts results to those with names that include the provided substring.

names.anyOfstring

Comma-separated list of names. Maximum of 100. Restricts results to those that match any of the specified names, case insensitive. Warning - this filter can be non-performant due to case insensitivity.

names.anyOf.caseSensitivestring

Comma-separated list of names. Maximum of 100. Restricts results to those that match any of the specified names, case sensitive.

modifiedAtstring

Datetime, in RFC 3339 format. Supports the > and < operators. Time zone defaults to UTC. Restricts results to those modified in the specified range. e.g. > 2017-04-30. Date ranges can be specified with the following nomenclature > YYYY-MM-DD AND <YYYY-MM-DD.

hasMembersstring

Comma-separated list of user or Benchling app IDs. Restricts results to organizations that include all the given users/apps as members.

hasAdminsstring

Comma-separated list of user or Benchling app IDs. Restricts results to organizations that include all the given users/apps as admins.

pageSizeinteger
nextTokenstring

Token for pagination

sort'createdAt' | 'createdAt:asc' | 'createdAt:desc' | 'modifiedAt' | 'modifiedAt:asc' | 'modifiedAt:desc' | 'name' | 'name:asc' | 'name:desc'

Sets the sort-order of the response. Valid sorts are modifiedAt (modified time, most recent first) and name (organization name, alphabetical). Optionally add :asc or :desc to specify ascending or descending order.

Response

OK

nextTokenstring

Changes

No recorded changes to this operation across all 1 revision of this API.