Retrieve organization information by id

Prev Next
Get
/GetOrganization/{id}

Allows you to get information about an organization.

Security
API Key
Header parameter nameapi_key
Path parameters
id
integer (int32) Required

The ID of the organization to retrieve

Responses
200

OK Response

Expand All
object
Status
integer (int32)

Indicates the status of the API request.

0 = Success
10 = Error
20 = Not found
30 = Invalid integration key

Example10
Error
string | null

Error details. This will only have a value if an error was encountered. The status property will also be set to Error (10).

Organization
object (Organization)
Id
integer (int32)

The organization's unique identifier

Example567
ExternalId
string | null

The organization's external ID, usually a unique identifier from the calling system

ExampleB93762AC6FEE987A
Name
string

The organization's name

ExampleChild Organization 1
Description
string | null

An optional description

ExampleA sample child organization
ParentId
string | null

The ID of the organization's parent organization

Example458
IntegrationKey
string

The organization's API integration key. This can be used for making API calls in the context of this organization as opposed to the context of a parent.

Example987654321
TimeZoneId
string

The organization's default time zone. This is used as a default when creating new users and events.

ExampleCentral Standard Time
Culture
string

The organization's default language/culture setting. This is used as a default when creating new users and events.

Exampleen-US
DefaultUserPassword
string | null

The default password for new users in the organization

ExamplePassword
DefaultUserNamePattern
string

The default pattern selected for creating a username for a new user in the organization.

  • Email
ExampleFirstNameLastName
Enabled
boolean

is the organization enabled.

ExampleTrue
Children
Array of integer

Identifiers of child organizations that belong to the organization

integer (int32)