The organization search API lets you retrieve the current user’s organization data.

​
Example use cases

  • Get current organization

    {
  "query_by": "*",
  "q": "*"
}

  • Get organization with custom fields and teams

    {
  "query_by": "*",
  "include_fields": "standardFields,customFields,customFieldValues,teams,sources",
  "q": "*"
}

​
Organization search response fields

Below are all the fields you may see in an organization search result. Many are optional and will only appear if included in your include_fields parameter.

​
Core fields

FieldTypeDescription
idstringUnique organization identifier
uidstringUnique organization UID
namestringOrganization name
descriptionstringOrganization description
logoUrlstringLogo URL or identifier
slugstringOrganization slug
allowSameDomainJoinbooleanWhether to allow same domain join
tierstringOrganization tier (e.g., ENTERPRISE)
isActivebooleanWhether the organization is active
isVerifiedbooleanWhether the organization is verified
metadataobjectCustom metadata
createdAtstringCreation timestamp (ISO8601)
updatedAtstringLast update timestamp (ISO8601)
deletedAtstringDeletion timestamp (ISO8601)

​
Extended fields (with include_fields)

FieldTypeDescription
standardFieldsarrayArray of standard field definitions
customFieldsarrayArray of custom field definitions
customFieldValuesarrayArray of custom field values
teamsarrayArray of teams in the organization
sourcesarrayArray of sources configured

​
Standard field structure

When standardFields is included, each field object contains:

FieldTypeDescription
idstringField identifier
namestringHuman-readable field name
typestringField type (string, text, url, boolean)
descriptionstringField description
mandatoryOnCreationbooleanWhether field is required on creation
mandatoryOnClosebooleanWhether field is required on close
visibleToCustomerbooleanWhether field is visible to customers
editableByCustomerbooleanWhether field is editable by customers
isStandardbooleanWhether this is a standard field

For a full list, see the OrganizationSearchResponseDto in the API reference.

​
Include fields options

Use the include_fields parameter to include additional data:

  • standardFields: Include standard field definitions
  • customFields: Include custom field definitions
  • customFieldValues: Include custom field values
  • teams: Include teams in the organization
  • sources: Include configured sources

Example:

{
  "query_by": "name",
  "include_fields": "standardFields,customFields,teams",
  "q": "*"
}

Tip: Use the include_fields parameter to limit the response to only the fields you need for performance and clarity. Only request extended fields when you need the additional data.