Hanzo
OpenapiIam

Returns the organizations you can act in, the ones you belong to first and the…

Returns the organizations you can act in, the ones you belong to first and the rest after, newest first, narrowed by an optional query against the name or…

GET /v1/iam/organizations/search

Addresshttps://api.hanzo.ai/v1/iam/organizations/search
MethodGET
OperationsearchOrganizations
AuthAuthorization: Bearer $HANZO_API_KEY

Returns the organizations you can act in, the ones you belong to first and the rest after, newest first, narrowed by an optional query against the name or the display name.

Platform operators see every organization; everyone else sees their own. Pass the cursor from the previous page to continue; an empty cursor in the answer means there is nothing more.

Request

4 fields.

FieldInTypeRequiredDescription
qquerystring
limitqueryinteger
cursorquerystring
X-Forwarded-Forheaderstring

Response

StatusBodyMeaning
200iam.SearchOrganizationsOutputok

200 body — 76 fields.

FieldInTypeAlwaysDescription
cursorbodystring
organizationsbodyiam.Organization[]
organizations[].accountItemsbodyiam.AccountItem[]
organizations[].accountItems[].modifyRulebodystring
organizations[].accountItems[].namebodystring
organizations[].accountItems[].regexbodystring
organizations[].accountItems[].tabbodystring
organizations[].accountItems[].viewRulebodystring
organizations[].accountItems[].visiblebodyboolean
organizations[].accountMenubodystring
organizations[].avatarbodystringHow the organization appears across Hanzo — the square mark beside its name — as an image or as one emoji, never both.
organizations[].balanceCreditbodynumber
organizations[].balanceCurrencybodystring
organizations[].countryCodesbodystring[]
organizations[].createdAtbodystring (date-time)
organizations[].createdTimebodystring
organizations[].dcrPolicybodystring
organizations[].defaultApplicationbodystring
organizations[].defaultAvatarbodystring
organizations[].defaultPasswordbodystring
organizations[].deletedbodyboolean
organizations[].disableSigninbodyboolean
organizations[].displayNamebodystring
organizations[].emojibodystring
organizations[].enableSoftDeletionbodyboolean
organizations[].enableTourbodyboolean
organizations[].failedSigninFrozenTimebodyinteger
organizations[].failedSigninLimitbodyintegerPer-organization signin throttle. Zero means "inherit the application default"; a non-zero value overrides it.
organizations[].faviconbodystring
organizations[].founderbodystringFounder is the stable storage id of the identity that provisioned this org (self-service onboarding).
organizations[].hasPrivilegeConsentbodyboolean
organizations[].idbodystring
organizations[].initScorebodyinteger
organizations[].ipRestrictionbodystring
organizations[].ipWhitelistbodystring
organizations[].isPersonalbodyboolean
organizations[].isProfilePublicbodyboolean
organizations[].kerberosKdcHostbodystring
organizations[].kerberosKeytabbodystring
organizations[].kerberosRealmbodystring
organizations[].kerberosServiceNamebodystring
organizations[].languagesbodystring[]
organizations[].ldapAttributesbodystring[]
organizations[].logobodystring
organizations[].logoDarkbodystring
organizations[].masterPasswordbodystring
organizations[].masterVerificationCodebodystring
organizations[].mfaItemsbodyiam.MfaItem[]
organizations[].mfaItems[].namebodystring
organizations[].mfaItems[].rulebodystring
organizations[].mfaRememberInHoursbodyinteger
organizations[].namebodystring
organizations[].navItemsbodystring[]
organizations[].orgBalancebodynumberBalance fields are read-only mirrors; authoritative balances live in Commerce (billing.hanzo.ai).
organizations[].ownerbodystring
organizations[].passwordExpireDaysbodyinteger
organizations[].passwordObfuscatorKeybodystring
organizations[].passwordObfuscatorTypebodystring
organizations[].passwordOptionsbodystring[]
organizations[].passwordSaltbodystring
organizations[].passwordTypebodystring
organizations[].tagsbodystring[]
organizations[].themeDatabodyiam.ThemeData
organizations[].themeData.borderRadiusbodyinteger
organizations[].themeData.colorPrimarybodystring
organizations[].themeData.isCompactbodyboolean
organizations[].themeData.isEnabledbodyboolean
organizations[].themeData.themeTypebodystring
organizations[].updatedAtbodystring (date-time)
organizations[].useEmailAsUsernamebodyboolean
organizations[].usePermanentAvatarbodyboolean
organizations[].userBalancebodynumber
organizations[].userNavItemsbodystring[]
organizations[].userTypesbodystring[]
organizations[].websiteUrlbodystring
organizations[].widgetItemsbodystring[]

Failure carries the platform error shape — see Errors.

Examples

hanzo iam organizations search

IAM API · All Hanzo APIs · Interactive reference

How is this guide?

On this page