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.eyJ1c2VyX2lkIjoidWFhLWlkLTM5IiwiZW1haWwiOiJlbWFpbC0zOUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI0MTM3MzY0fQ.NVSvws8wBpTkyUBXPZ-wbSf0hZUfUj9XWcyUI0DoYmw
Host: example.org
Cookie: 

Route

GET /v2/organizations/8cd38bf7-257b-4a1c-95af-ac971648d17a

cURL

curl "https://api.[your-domain.com]/v2/organizations/8cd38bf7-257b-4a1c-95af-ac971648d17a" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM5IiwiZW1haWwiOiJlbWFpbC0zOUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI0MTM3MzY0fQ.NVSvws8wBpTkyUBXPZ-wbSf0hZUfUj9XWcyUI0DoYmw" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 5e861dd0-3a14-4c50-a2ef-50a6535b650f
Content-Length: 1298
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "metadata": {
    "guid": "8cd38bf7-257b-4a1c-95af-ac971648d17a",
    "url": "/v2/organizations/8cd38bf7-257b-4a1c-95af-ac971648d17a",
    "created_at": "2015-02-10T01:42:44Z",
    "updated_at": null
  },
  "entity": {
    "name": "name-91",
    "billing_enabled": false,
    "quota_definition_guid": "35185dbb-63bd-4269-ac38-1e5b7586341a",
    "status": "active",
    "quota_definition_url": "/v2/quota_definitions/35185dbb-63bd-4269-ac38-1e5b7586341a",
    "spaces_url": "/v2/organizations/8cd38bf7-257b-4a1c-95af-ac971648d17a/spaces",
    "domains_url": "/v2/organizations/8cd38bf7-257b-4a1c-95af-ac971648d17a/domains",
    "private_domains_url": "/v2/organizations/8cd38bf7-257b-4a1c-95af-ac971648d17a/private_domains",
    "users_url": "/v2/organizations/8cd38bf7-257b-4a1c-95af-ac971648d17a/users",
    "managers_url": "/v2/organizations/8cd38bf7-257b-4a1c-95af-ac971648d17a/managers",
    "billing_managers_url": "/v2/organizations/8cd38bf7-257b-4a1c-95af-ac971648d17a/billing_managers",
    "auditors_url": "/v2/organizations/8cd38bf7-257b-4a1c-95af-ac971648d17a/auditors",
    "app_events_url": "/v2/organizations/8cd38bf7-257b-4a1c-95af-ac971648d17a/app_events",
    "space_quota_definitions_url": "/v2/organizations/8cd38bf7-257b-4a1c-95af-ac971648d17a/space_quota_definitions"
  }
}