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.eyJ1c2VyX2lkIjoidWFhLWlkLTEyIiwiZW1haWwiOiJlbWFpbC0xMkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI0NDcxNjg1fQ.1EYkk2JgXB0rr_ukpvJn7t9_5z4UtfndHfd_g3TIgAI
Host: example.org
Cookie: 

Route

GET /v2/organizations/37f1e8bc-6d7a-4873-bfb2-18507745c6f4

cURL

curl "https://api.[your-domain.com]/v2/organizations/37f1e8bc-6d7a-4873-bfb2-18507745c6f4" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEyIiwiZW1haWwiOiJlbWFpbC0xMkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI0NDcxNjg1fQ.1EYkk2JgXB0rr_ukpvJn7t9_5z4UtfndHfd_g3TIgAI" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 60ca1147-9a29-4c1a-b1de-0620e8953613
Content-Length: 1298
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "metadata": {
    "guid": "37f1e8bc-6d7a-4873-bfb2-18507745c6f4",
    "url": "/v2/organizations/37f1e8bc-6d7a-4873-bfb2-18507745c6f4",
    "created_at": "2015-02-13T22:34:45Z",
    "updated_at": null
  },
  "entity": {
    "name": "name-36",
    "billing_enabled": false,
    "quota_definition_guid": "30159a8f-7ed0-42d1-8084-d852a583abb2",
    "status": "active",
    "quota_definition_url": "/v2/quota_definitions/30159a8f-7ed0-42d1-8084-d852a583abb2",
    "spaces_url": "/v2/organizations/37f1e8bc-6d7a-4873-bfb2-18507745c6f4/spaces",
    "domains_url": "/v2/organizations/37f1e8bc-6d7a-4873-bfb2-18507745c6f4/domains",
    "private_domains_url": "/v2/organizations/37f1e8bc-6d7a-4873-bfb2-18507745c6f4/private_domains",
    "users_url": "/v2/organizations/37f1e8bc-6d7a-4873-bfb2-18507745c6f4/users",
    "managers_url": "/v2/organizations/37f1e8bc-6d7a-4873-bfb2-18507745c6f4/managers",
    "billing_managers_url": "/v2/organizations/37f1e8bc-6d7a-4873-bfb2-18507745c6f4/billing_managers",
    "auditors_url": "/v2/organizations/37f1e8bc-6d7a-4873-bfb2-18507745c6f4/auditors",
    "app_events_url": "/v2/organizations/37f1e8bc-6d7a-4873-bfb2-18507745c6f4/app_events",
    "space_quota_definitions_url": "/v2/organizations/37f1e8bc-6d7a-4873-bfb2-18507745c6f4/space_quota_definitions"
  }
}