Home
Version 3
Organizations API

Organizations API

Get Organization summary

GET /v2/organizations/:guid/summary

Request

Route

GET /v2/organizations/bb15397d-9a9a-4960-a30d-31dc0c0f0f07/summary

Body

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

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE0OSIsImVtYWlsIjoiZW1haWwtODdAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ1MTQxMzY4Mn0.m2VQPsGK2YpmZKWoNRiNA3xaoaFT9kw4ZR7Um6M7UOU
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/organizations/bb15397d-9a9a-4960-a30d-31dc0c0f0f07/summary" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE0OSIsImVtYWlsIjoiZW1haWwtODdAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ1MTQxMzY4Mn0.m2VQPsGK2YpmZKWoNRiNA3xaoaFT9kw4ZR7Um6M7UOU" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "guid": "bb15397d-9a9a-4960-a30d-31dc0c0f0f07",
  "name": "name-482",
  "status": "active",
  "spaces": [
    {
      "guid": "864e8e02-3e7e-4e6d-b0ae-81fe6ac7c67d",
      "name": "name-484",
      "service_count": 0,
      "app_count": 0,
      "mem_dev_total": 0,
      "mem_prod_total": 0
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 
Content-Length: 229
X-Content-Type-Options: nosniff