Home
Version 3
Organizations API

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.eyJ1c2VyX2lkIjoidWFhLWlkLTI1NCIsImVtYWlsIjoiZW1haWwtMTk0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQzMTAxMzV9.ivBskGISJxp02UY6YgAO9qeIS5LXL8JhskG_ePu_s1E
Host: example.org
Cookie: 

Route

GET /v2/organizations/1594a2a8-0bd0-4093-bd68-56b31fed479f/summary

cURL

curl "https://api.[your-domain.com]/v2/organizations/1594a2a8-0bd0-4093-bd68-56b31fed479f/summary" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI1NCIsImVtYWlsIjoiZW1haWwtMTk0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQzMTAxMzV9.ivBskGISJxp02UY6YgAO9qeIS5LXL8JhskG_ePu_s1E" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: a53393d2-2fa5-4e8d-9821-1dda4dff66a1
Content-Length: 231
X-Content-Type-Options: nosniff

Status

200 OK

Body

{"guid":"1594a2a8-0bd0-4093-bd68-56b31fed479f","name":"name-1564","status":"active","spaces":[{"guid":"fae1094b-bca3-4e78-9c62-a5769888e046","name":"name-1566","service_count":0,"app_count":0,"mem_dev_total":0,"mem_prod_total":0}]}