To enable prefix filtering append * to the end of the value and ensure you provide at least 3 characters excluding the wildcard.
This filter is case-insensitivity.
email
string
Filter the results by email address.
To enable prefix filtering append * to the end of the value and ensure you provide at least 3 characters excluding the wildcard.
This filter is case-insensitivity.
pageSize
int32
The maximum number of organizations to return. The API may return fewer than this value.
If unspecified, at most 20 organizations will be returned. The maximum value is 100; values above 100 will be coerced to 100.
pageToken
string
A page token, received from a previous list organizations call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to list organizations must match the call that provided the page token.
orderBy
string
A comma-separated list of fields to order by.
showDeleted
boolean
Whether to show deleted organizations.
view
enum
The organization view to return in the results.
This defaults to the BASIC view.
Possible values:
BASICFULL
Returns
organizations
Organization[]
BASIC
The list of organizations.
id
string
The system-assigned identifier of the organization.
state
enum
The current state of the organization.
Possible values:
ACTIVEDISABLEDARCHIVEDPENDING_DELETION
stateReason
string
The code that best describes the reason for the state.
uniqueId
string
The client defined unique identifier of the organization account.
displayName
string
The human-readable display name of the organization.
email
string
The email address of the organization.
emailVerified
boolean
Whether the organization's email address has been verified.
phoneNumber
string
The E164 phone number for the organization (e.g. +12125550123).
phoneNumberVerified
boolean
Whether the organization's phone number has been verified.
imageUrl
string
The photo/avatar URL of the organization.
currencyCode
string
The default ISO-4217 currency code for the organization (e.g. USD).
languageCode
string
The IETF BCP-47 language code for the organization (e.g. en).
regionCode
string
The country/region code for the organization (e.g. US).
timeZone
string
The IANA time zone for the organization (e.g. America/New_York).
address
Address
The default address for the organization.
lines
string[]
The address lines.
city
string
The city, district, suburb, town, or village.
state
string
The state, country, province, or region.
postalCode
string
The ZIP or postal code.
country
string
The 2-letter country code.
signupTime
date-time
The sign-up time for the organization.
memberCount
int32
The number of members in the organization.
This includes disabled users, but does not include user's marked for deletion.
disabled
boolean
Whether the organization is disabled.
view
enum
The organization view.
Possible values:
BASICFULL
createTime
date-time
The creation time of the organization.
updateTime
date-time
The last update time of the organization.
nextPageToken
string
A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.
previousPageToken
string
A token, which can be sent as pageToken to retrieve the previous page. If this field is absent, there are no preceding pages. If this field is an empty string then the previous page is the first result.