Get organization details

GET

/api/v1/gen_organizations/{organization_id}

Retrieve details of a specific organization.

Parameters

Path Parameters

organization_id

required

Organization Id

string

Responses

200

Successful Response

OrganizationResponse

Full organization response model

object

id

required

Id

integer

uuid

Any of:

string

string

null

null

name

required

Name

string

credit_plan

Any of:

object

object

key

additional properties

any

null

null

organization_id

required

Organization Id

integer

avatar

Any of:

OrganizationAvatar

OrganizationAvatar

object

url

Any of:

string

string

null

null

thumbnail_url

Any of:

string

string

null

null

key

additional properties

any

null

null

user_role

Any of:

string

string

null

null

credit

Any of:

string

string

null

null

available_credit

Any of:

AvailableCredit

AvailableCredit

object

generic

Any of:

string

string

null

null

aura

Any of:

string

string

null

null

key

additional properties

any

null

null

total_members

Any of:

integer

integer

null

null

key

additional properties

any

400

Bad Request

ErrorResponse

object

detail

Any of:

string

string

null

null

error

Any of:

string

string

null

null

error_code

Any of:

string

string

null

null

403

Forbidden: You cannot update your own role, or the role of the owner, or remove yourself from the organization.

ErrorResponse

object

detail

Any of:

string

string

null

null

error

Any of:

string

string

null

null

error_code

Any of:

string

string

null

null

Example

{
  "error": "You cannot update your own role",
  "error_code": "cannot_update_own_role"
}

404

Not Found: User not found, or user is not a member of this organization.

ErrorResponse

object

detail

Any of:

string

string

null

null

error

Any of:

string

string

null

null

error_code

Any of:

string

string

null

null

Example

{
  "error": "User not found",
  "error_code": "user_not_found"
}

422

Unprocessable Content: Validation error (e.g., invalid parameters).

ErrorResponse

object

detail

Any of:

string

string

null

null

error

Any of:

string

string

null

null

error_code

Any of:

string

string

null

null

Example

{
  "error": "Name is too long",
  "error_code": "validation_error"
}

500

Internal Server Error

ErrorResponse

object

detail

Any of:

string

string

null

null

error

Any of:

string

string

null

null

error_code

Any of:

string

string

null

null