Fetch an org by id

GET

/v1/orgs/{orgId}

curl --request GET \
  --url https://example.com/v1/orgs/example \
  --header 'Authorization: Bearer <token>'

• Same-origin — path relative to the deployment root.

Authorizations

• bearerAuth

Parameters

Path Parameters

orgId

required

string

OrgId — opaque branded string.

Responses

200

Org.

Media typeapplication/json

object

id

required

OrgId — opaque branded string.

string

tenantId

required

string

name

required

string

slug

required

string

createdAt

required

string

updatedAt

required

string

Example^generated

{
  "id": "example",
  "tenantId": "example",
  "name": "example",
  "slug": "example",
  "createdAt": "example",
  "updatedAt": "example"
}

401

Missing / malformed / expired / revoked bearer token.

Media typeapplication/json

object

error

required

object

code

required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string

message

required

string

details

Optional, kind-specific.

object

key

additional properties

any

requestId

required

Server-assigned request id; also echoed via X-Request-Id header.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

404

No org with that id under this tenant.

Media typeapplication/json

object

error

required

object

code

required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string

message

required

string

details

Optional, kind-specific.

object

key

additional properties

any

requestId

required

Server-assigned request id; also echoed via X-Request-Id header.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}