Skip to main content

Get organization by ID

Gets the details for an organization.

Path Parameters
organizationId uuid REQUIRED
Responses
200

Default Response

Schema OPTIONAL
createdAt OPTIONAL
updatedAt OPTIONAL
defaultProjectId OPTIONAL
billingEmails OPTIONAL
billingPhoneNumber OPTIONAL
billingAddress OPTIONAL
subscription OPTIONAL
stripe OPTIONAL
id uuid OPTIONAL
name string

Possible values: 3 ≤ length ≤ 1024

dateCreated integer
dateUpdated integer
primaryDomain string
slug string

Possible values: length ≤ 256

projects object[] OPTIONAL
default OPTIONAL
contactEmail email OPTIONAL
contactEmails email[] OPTIONAL
dateCreated integer
dateUpdated integer
id uuid
mode OPTIONAL
name string

Possible values: 3 ≤ length ≤ 1024

organizationId uuid
organization object OPTIONAL
id uuid
name string

Possible values: 3 ≤ length ≤ 1024

slug string

Possible values: length ≤ 256

status string OPTIONAL
sendFromEmailId OPTIONAL
sendFromEmail object OPTIONAL
id OPTIONAL
email email OPTIONAL
name string OPTIONAL
slug string

Possible values: length ≤ 256

status string OPTIONAL

Possible values: [active, test, archived]

statusFlags object
isActive OPTIONAL
isTest OPTIONAL
type

Possible values: [website]

status string OPTIONAL

Possible values: [active, suspended, disabled, deleted]

statusDate integer
statusFlags object
isActive OPTIONAL
features OPTIONAL
400

Bad request response.

Schema OPTIONAL
statusCode int32

The status code of the request.

error string

The error string for the status code.

message string

Description of the error encounted.

401

Unauthorized response.

Schema OPTIONAL
statusCode int32

The status code of the request.

error string

The error string for the status code.

message string
403

Forbidden response.

Schema OPTIONAL
statusCode int32

The status code of the request.

error string
message string
404

Not found response.

Schema OPTIONAL
statusCode int32
error string
message string
422

Unprocessable Entity response.

Schema OPTIONAL
statusCode int32
error string
message string

Description of the error encounted.

500

Internal server error response.

Schema OPTIONAL
statusCode int32
error string
message string

Will always be "Internal Server Error"