Skip to content
Mengi Cloud Mengi Cloud Docs

Get Organization

GET
/organizations/{slug}
 
curl --request GET \
  --url https://api.mengi.cloud/organizations/example

Get organization details by slug.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
slug
required
Slug
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
OrganizationDetailResponse
object
id
required
Id
string format: uuid
name
required
Name
string
slug
required
Slug
string
is_system
required
Is System
boolean
avatar_url
required
Any of:
string
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
member_count
Any of:
integer
current_user_role
Any of:
OrganizationRole
string
Allowed values: owner admin member
members
Members
Array<object>
default:
OrganizationMemberResponse
object
id
required
Id
string format: uuid
organization_id
required
Organization Id
string format: uuid
user_id
required
User Id
string format: uuid
role
required
OrganizationRole
string
Allowed values: owner admin member
created_at
required
Created At
string format: date-time
user_email
Any of:
string
user_name
Any of:
string
user_avatar_url
Any of:
string
Example 
{
  "current_user_role": "owner",
  "members": []
}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}