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.eyJ1c2VyX2lkIjoidWFhLWlkLTI4NiIsImVtYWlsIjoiZW1haWwtMjE4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTk5ODk5Nzd9.W8SkUxP-IXdvrnROiESWT4RXeXuQr_ud-aab9SnMZZw
Host: example.org
Cookie: 

Route

GET /v2/organizations/2082369a-63f7-4f95-99ac-7dfed03a27b3

cURL

curl "https://api.[your-domain.com]/v2/organizations/2082369a-63f7-4f95-99ac-7dfed03a27b3" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI4NiIsImVtYWlsIjoiZW1haWwtMjE4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTk5ODk5Nzd9.W8SkUxP-IXdvrnROiESWT4RXeXuQr_ud-aab9SnMZZw" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: c8955847-fdd7-4f63-ae0d-6cb81b21d288
Content-Length: 1305
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "metadata": {
    "guid": "2082369a-63f7-4f95-99ac-7dfed03a27b3",
    "url": "/v2/organizations/2082369a-63f7-4f95-99ac-7dfed03a27b3",
    "created_at": "2014-12-24T01:39:37+00:00",
    "updated_at": null
  },
  "entity": {
    "name": "name-1725",
    "billing_enabled": false,
    "quota_definition_guid": "0ba82bd7-983d-4b26-889a-b772d01ff78e",
    "status": "active",
    "quota_definition_url": "/v2/quota_definitions/0ba82bd7-983d-4b26-889a-b772d01ff78e",
    "spaces_url": "/v2/organizations/2082369a-63f7-4f95-99ac-7dfed03a27b3/spaces",
    "domains_url": "/v2/organizations/2082369a-63f7-4f95-99ac-7dfed03a27b3/domains",
    "private_domains_url": "/v2/organizations/2082369a-63f7-4f95-99ac-7dfed03a27b3/private_domains",
    "users_url": "/v2/organizations/2082369a-63f7-4f95-99ac-7dfed03a27b3/users",
    "managers_url": "/v2/organizations/2082369a-63f7-4f95-99ac-7dfed03a27b3/managers",
    "billing_managers_url": "/v2/organizations/2082369a-63f7-4f95-99ac-7dfed03a27b3/billing_managers",
    "auditors_url": "/v2/organizations/2082369a-63f7-4f95-99ac-7dfed03a27b3/auditors",
    "app_events_url": "/v2/organizations/2082369a-63f7-4f95-99ac-7dfed03a27b3/app_events",
    "space_quota_definitions_url": "/v2/organizations/2082369a-63f7-4f95-99ac-7dfed03a27b3/space_quota_definitions"
  }
}