Get an organization

GET 
/api/v1/organizations/:orgId

Get an organization

Request

Path Parameters

orgId stringrequired

organization id

Header Parameters

X-API-KEY stringrequired

APIKey

Responses

200

OK

application/json

Schema

Schema

data

object

createdAt string

createdAt is the creation time of the organization.

id string

id is the unique identifier of the organization.

name string

name is the name of the organization.

orgNamespace string

orgNamespace is the organization namespace.

owner boolean

owner is the organization owner.

slug string

slug is the organization slug.

id string
message string
status string

Example (from schema)

{
  "data": {
    "createdAt": "string",
    "id": "string",
    "name": "string",
    "orgNamespace": "string",
    "owner": true,
    "slug": "string"
  },
  "id": "string",
  "message": "string",
  "status": "string"
}

400

invalid request

application/json

Schema

Schema

error string
error_code string

Example (from schema)

{
  "error": "string",
  "error_code": "string"
}

404

organization not found

application/json

Schema

Schema

error string
error_code string

Example (from schema)

{
  "error": "string",
  "error_code": "string"
}

500

internal server error

application/json

Schema

Schema

error string
error_code string

Example (from schema)

{
  "error": "string",
  "error_code": "string"
}

Loading...