---
title: "Retrieve organization information by external platform id"
slug: "retrieve-organization-information-by-external-platform-id"
updated: 2024-10-25T18:04:27Z
published: 2026-02-10T22:32:35Z
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.skillable.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieve organization information by external platform id

Get/GetOrganizationByExternalId/{id}

Allows you to get information about an organization by providing a unique identifier from your external system.

SecurityAPI Key: api_keyHeader parameter nameapi_key

Path parametersidstringRequired

The external ID of the organization to retrieve.

Responses200

OK Response

<select class='api-response-data' aria-label='Media type'><option value='c03617eb-4351-4da9-bda5-8d37c94f767d'>application/json</option>
</select>Expand Allobject  Statusinteger  (int32)    

Indicates the status of the API request.

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

Example10
Errorstring   | null  

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

Organizationobject (Organization)  Idinteger  (int32)    

The organization's unique identifier

Example567
ExternalIdstring   | null  

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

ExampleB93762AC6FEE987A
Namestring    

The organization's name

ExampleChild Organization 1
Descriptionstring   | null  

An optional description

ExampleA sample child organization
ParentIdstring   | null  

The ID of the organization's parent organization

Example458
IntegrationKeystring    

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
TimeZoneIdstring    

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

ExampleCentral Standard Time
Culturestring    

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

Exampleen-US
DefaultUserPasswordstring   | null  

The default password for new users in the organization

ExamplePassword
DefaultUserNamePatternstring    

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

- Email

ExampleFirstNameLastName
Enabledboolean    

is the organization enabled.

Exampletrue

Children Array of integer   

Identifiers of child organizations that belong to the organization

integer  (int32)
