Organizations API

List all Organizations

GET /v2/organizations

Fields

Name	Description	Default	Valid Values	Example Values

Parameters

Name	Description	Valid Values	Example Values
q	Parameters used to filter the result set. Format queries as <filter><op><value> Valid ops: : >= <= < > IN Valid filters: name, space_guid, user_guid, manager_guid, billing_manager_guid, auditor_guid, status		q=filter:value q=filter>value q=filter IN a,b,c
page	Page of results to fetch
results-per-page	Number of results per page
order-direction	Order of the results: asc (default) or desc
inline-relations-depth	0 - don't inline any relations and return URLs. Otherwise, inline to depth N.
orphan-relations	0 - de-duplicate object entries in response
exclude-relations	comma-delimited list of relations to drop from response
include-relations	comma-delimited list of the only relations to include in response

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM4IiwiZW1haWwiOiJlbWFpbC0zOEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI0MTM3MzY0fQ.8zEOyFzPUq4I2baOScRbJMrvV2fJLTrELuw1oE9x9CI
Host: example.org
Cookie: 

Route

GET /v2/organizations

cURL

curl "https://api.[your-domain.com]/v2/organizations" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM4IiwiZW1haWwiOiJlbWFpbC0zOEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI0MTM3MzY0fQ.8zEOyFzPUq4I2baOScRbJMrvV2fJLTrELuw1oE9x9CI" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: eee8bc91-d47c-4be0-99cf-391b38151f02
Content-Length: 1520
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "5898818d-1720-436f-af1c-5ccda838a249",
        "url": "/v2/organizations/5898818d-1720-436f-af1c-5ccda838a249",
        "created_at": "2015-02-10T01:42:41Z",
        "updated_at": null
      },
      "entity": {
        "name": "the-system_domain-org-name",
        "billing_enabled": false,
        "quota_definition_guid": "c6cc175a-f24a-469b-93d9-5800259f7967",
        "status": "active",
        "quota_definition_url": "/v2/quota_definitions/c6cc175a-f24a-469b-93d9-5800259f7967",
        "spaces_url": "/v2/organizations/5898818d-1720-436f-af1c-5ccda838a249/spaces",
        "domains_url": "/v2/organizations/5898818d-1720-436f-af1c-5ccda838a249/domains",
        "private_domains_url": "/v2/organizations/5898818d-1720-436f-af1c-5ccda838a249/private_domains",
        "users_url": "/v2/organizations/5898818d-1720-436f-af1c-5ccda838a249/users",
        "managers_url": "/v2/organizations/5898818d-1720-436f-af1c-5ccda838a249/managers",
        "billing_managers_url": "/v2/organizations/5898818d-1720-436f-af1c-5ccda838a249/billing_managers",
        "auditors_url": "/v2/organizations/5898818d-1720-436f-af1c-5ccda838a249/auditors",
        "app_events_url": "/v2/organizations/5898818d-1720-436f-af1c-5ccda838a249/app_events",
        "space_quota_definitions_url": "/v2/organizations/5898818d-1720-436f-af1c-5ccda838a249/space_quota_definitions"
      }
    }
  ]
}