Organizations API

Get Organization summary

GET /v2/organizations/:guid/summary

Fields

Name	Description	Default	Valid Values	Example Values
guid	The guid of the organization for which summary is requested
name	The name of the organization.
spaces	List of spaces that are in the organization
status	Status of the organization

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTY0IiwiZW1haWwiOiJlbWFpbC01N0Bzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDE2NTI2Njk5fQ.wU3UrHmxLERhdvCKm4qU_4GFwJE7hmInWnKKCTL_m_w
Host: example.org
Cookie: 

Route

GET /v2/organizations/6efd06fc-0fc9-4427-b9a7-acf6151cc4a1/summary

cURL

curl "https://api.[your-domain.com]/v2/organizations/6efd06fc-0fc9-4427-b9a7-acf6151cc4a1/summary" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTY0IiwiZW1haWwiOiJlbWFpbC01N0Bzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDE2NTI2Njk5fQ.wU3UrHmxLERhdvCKm4qU_4GFwJE7hmInWnKKCTL_m_w" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: aa24038b-5fc5-49a3-8aee-6e9df22fc09c
Content-Length: 229
X-Content-Type-Options: nosniff

Status

200 OK

Body

{"guid":"6efd06fc-0fc9-4427-b9a7-acf6151cc4a1","name":"name-392","status":"active","spaces":[{"guid":"f6b86cf7-e2ef-45f8-8e4d-cf18498097ec","name":"name-394","service_count":0,"app_count":0,"mem_dev_total":0,"mem_prod_total":0}]}