Organization -- Organizations

Read Organization

Returns the specified Organization.

An Organization is the highest-level resource that can contain multiple Workspaces.

get/organizations/{organizationId}

Request

  • Base URL: https://partner.peaka.studio/api/v1
  • URL: https://partner.peaka.studio/api/v1/organizations/{organizationId}
  • Auth: HTTP bearer

Path parameters

organizationIdstring required

ID of the Organization

Response

Successful operation

idstring uuid

The unique identifier of the organization

namestring

The name of the organization

ownerstring uuid

The unique identifier of the user who created the organization

createdAtstring

The date and time the organization was created

iconFileIdstring

The identifier of the file that contains the icon of the organization

descriptionstring

Descriptive text about the organization

Changes

No recorded changes to this operation across all 1 revision of this API.