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.eyJ1c2VyX2lkIjoidWFhLWlkLTE2OSIsImVtYWlsIjoiZW1haWwtMTMyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTY1MjY3MDR9.1O9t2Tiw7FN5rajFUeKCrx0VV4PnC9hrHV9UJQkWV6Y
Host: example.org
Cookie: 

Route

GET /v2/organizations/23c62fb8-5b73-4bbc-9327-f337e81a859f

cURL

curl "https://api.[your-domain.com]/v2/organizations/23c62fb8-5b73-4bbc-9327-f337e81a859f" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE2OSIsImVtYWlsIjoiZW1haWwtMTMyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTY1MjY3MDR9.1O9t2Tiw7FN5rajFUeKCrx0VV4PnC9hrHV9UJQkWV6Y" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: b2d9c2f7-9d35-4e51-a52f-8761b71a60d0
Content-Length: 1304
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "metadata": {
    "guid": "23c62fb8-5b73-4bbc-9327-f337e81a859f",
    "url": "/v2/organizations/23c62fb8-5b73-4bbc-9327-f337e81a859f",
    "created_at": "2014-11-13T23:38:24+00:00",
    "updated_at": null
  },
  "entity": {
    "name": "name-713",
    "billing_enabled": false,
    "quota_definition_guid": "1f21247f-af9d-45f9-9b58-6287f17568ca",
    "status": "active",
    "quota_definition_url": "/v2/quota_definitions/1f21247f-af9d-45f9-9b58-6287f17568ca",
    "spaces_url": "/v2/organizations/23c62fb8-5b73-4bbc-9327-f337e81a859f/spaces",
    "domains_url": "/v2/organizations/23c62fb8-5b73-4bbc-9327-f337e81a859f/domains",
    "private_domains_url": "/v2/organizations/23c62fb8-5b73-4bbc-9327-f337e81a859f/private_domains",
    "users_url": "/v2/organizations/23c62fb8-5b73-4bbc-9327-f337e81a859f/users",
    "managers_url": "/v2/organizations/23c62fb8-5b73-4bbc-9327-f337e81a859f/managers",
    "billing_managers_url": "/v2/organizations/23c62fb8-5b73-4bbc-9327-f337e81a859f/billing_managers",
    "auditors_url": "/v2/organizations/23c62fb8-5b73-4bbc-9327-f337e81a859f/auditors",
    "app_events_url": "/v2/organizations/23c62fb8-5b73-4bbc-9327-f337e81a859f/app_events",
    "space_quota_definitions_url": "/v2/organizations/23c62fb8-5b73-4bbc-9327-f337e81a859f/space_quota_definitions"
  }
}