GetOrganization

GET

https://orgs.ezghcloud.com/v1/organizations/{orgId}

View as Markdown

Authorization

apiKeyoptionalHTTP
sessionCookieoptionalAPI key in cookie
oauthoptionalHTTP

Path parameters

orgIdstringrequired

Returns

200

Success

JSON

idstringrequired
namestringrequired
slugstringrequired
resourceNamestringrequired
createdAtstringrequired
updatedAtstringrequired
isRootbooleanrequired

400

InvalidRequest

JSON

errorobjectrequired
3 properties
- codeinvalid_requestrequired
- messagestringrequired
- issuesoptionalarray ofobject
  2 properties
  pathstringrequired
  messagestringrequired

401

Unauthenticated

JSON

errorobjectrequired
2 properties
- codeunauthenticatedrequired
- messagestringrequired

403

AccessDenied | ForbiddenOrigin

JSON

One of the following:

AccessDeniedEncoded
View AccessDeniedEncoded schema →
1 properties
- errorobjectrequired
  2 properties
  codeaccess_deniedrequired
  messagestringrequired
ForbiddenOriginEncoded
View ForbiddenOriginEncoded schema →
1 properties
- errorobjectrequired
  2 properties
  codeforbidden_originrequired
  messagestringrequired

404

NotFound

JSON

errorobjectrequired
2 properties
- codenot_foundrequired
- messagestringrequired

429

TooManyRequests

JSON

errorobjectrequired
2 properties
- codetoo_many_requestsrequired
- messagestringrequired

500

InternalError

JSON

errorobjectrequired
2 properties
- codeinternal_errorrequired
- messagestringrequired

503

Unavailable

JSON

errorobjectrequired
2 properties
- codeunavailablerequired
- messagestringrequired

GetOrganization

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

const url = 'https://orgs.ezghcloud.com/v1/organizations/string';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Response example

{
  "id": "string",
  "name": "string",
  "slug": "string",
  "resourceName": "string",
  "createdAt": "string",
  "updatedAt": "string",
  "isRoot": true
}

{
  "error": {
    "code": "invalid_request",
    "message": "string",
    "issues": [
      {
        "path": "string",
        "message": "string"
      }
    ]
  }
}

{
  "error": {
    "code": "unauthenticated",
    "message": "string"
  }
}

{
  "error": {
    "code": "access_denied",
    "message": "string"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "string"
  }
}

{
  "error": {
    "code": "too_many_requests",
    "message": "string"
  }
}

{
  "error": {
    "code": "internal_error",
    "message": "string"
  }
}

{
  "error": {
    "code": "unavailable",
    "message": "string"
  }
}