Home
Version 3
Organizations API

Organizations API

Retrieve a Particular Organization

GET /v2/organizations/:guid

Fields

Name Description Default Valid Values Example Values

Parameters

Name Description Valid Values Example Values
guid The guid of the Organization

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM4MSIsImVtYWlsIjoiZW1haWwtMjgzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjI5OTA4ODZ9.33LWrxOAyOGGVmae1t4Exrhpw525CcETCXcLK1vrots
Host: example.org
Cookie: 

Route

GET /v2/organizations/98dde81e-1e9a-4321-b70c-6aa02a3a78f0

cURL

curl "https://api.[your-domain.com]/v2/organizations/98dde81e-1e9a-4321-b70c-6aa02a3a78f0" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM4MSIsImVtYWlsIjoiZW1haWwtMjgzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjI5OTA4ODZ9.33LWrxOAyOGGVmae1t4Exrhpw525CcETCXcLK1vrots" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: b5ac57cd-7b11-4a2d-b21b-34b8f176d5bc
Content-Length: 1300
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "metadata": {
    "guid": "98dde81e-1e9a-4321-b70c-6aa02a3a78f0",
    "url": "/v2/organizations/98dde81e-1e9a-4321-b70c-6aa02a3a78f0",
    "created_at": "2015-01-27T19:14:46Z",
    "updated_at": null
  },
  "entity": {
    "name": "name-2004",
    "billing_enabled": false,
    "quota_definition_guid": "42f079e2-d939-450d-b25f-115e0b54a723",
    "status": "active",
    "quota_definition_url": "/v2/quota_definitions/42f079e2-d939-450d-b25f-115e0b54a723",
    "spaces_url": "/v2/organizations/98dde81e-1e9a-4321-b70c-6aa02a3a78f0/spaces",
    "domains_url": "/v2/organizations/98dde81e-1e9a-4321-b70c-6aa02a3a78f0/domains",
    "private_domains_url": "/v2/organizations/98dde81e-1e9a-4321-b70c-6aa02a3a78f0/private_domains",
    "users_url": "/v2/organizations/98dde81e-1e9a-4321-b70c-6aa02a3a78f0/users",
    "managers_url": "/v2/organizations/98dde81e-1e9a-4321-b70c-6aa02a3a78f0/managers",
    "billing_managers_url": "/v2/organizations/98dde81e-1e9a-4321-b70c-6aa02a3a78f0/billing_managers",
    "auditors_url": "/v2/organizations/98dde81e-1e9a-4321-b70c-6aa02a3a78f0/auditors",
    "app_events_url": "/v2/organizations/98dde81e-1e9a-4321-b70c-6aa02a3a78f0/app_events",
    "space_quota_definitions_url": "/v2/organizations/98dde81e-1e9a-4321-b70c-6aa02a3a78f0/space_quota_definitions"
  }
}