v1

OpenAPI 3.0.1Apache 2.02026-07-135212282.4 KB
organizations

Get a organization.

get/api/v1/orgs/organizations/{org_id}/

Path parameters

org_idstring uuid required

The unique identifier of the organization

Response

Successful response.

idinteger

Unique identifier for the organization.

org_idstring

Unique organization ID

namestring

Name of the organization.

descriptionstring

Description of the organization

addressstring

Address of the organization

contact_emailstring email

Contact email for the organization

phone_numberstring

Phone number of the organization

websitestring uri

Website of the organization

on_paid_planboolean

Indicates if the organization is on a paid plan

created_atstring date-time

Timestamp of when the organization was created.

updated_atstring date-time

Timestamp of when the organization was last updated.

ownerinteger

Identifier of the organization's owner

membersinteger[]

List of member identifiers belonging to the organization.