Home
Version 3
Organizations API

Organizations API

List all Organizations

GET /v2/organizations

Request

Route

GET /v2/organizations

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

Body

Name Description Default Valid Values Example Values

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI3IiwiZW1haWwiOiJlbWFpbC0yN0Bzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI3NDgwODQyfQ.AsSmp-zvZq1TOeepI0hukXciqEWplQ3BeHCjfgsUFto
Host: example.org
Cookie: 

cURL

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

Response

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "ef9fd3f7-9ada-45e0-b85a-f351d1864235",
        "url": "/v2/organizations/ef9fd3f7-9ada-45e0-b85a-f351d1864235",
        "created_at": "2015-03-20T18:27:18Z",
        "updated_at": null
      },
      "entity": {
        "name": "the-system_domain-org-name",
        "billing_enabled": false,
        "quota_definition_guid": "ba3088cc-0d52-4631-9655-522edd338b29",
        "status": "active",
        "quota_definition_url": "/v2/quota_definitions/ba3088cc-0d52-4631-9655-522edd338b29",
        "spaces_url": "/v2/organizations/ef9fd3f7-9ada-45e0-b85a-f351d1864235/spaces",
        "domains_url": "/v2/organizations/ef9fd3f7-9ada-45e0-b85a-f351d1864235/domains",
        "private_domains_url": "/v2/organizations/ef9fd3f7-9ada-45e0-b85a-f351d1864235/private_domains",
        "users_url": "/v2/organizations/ef9fd3f7-9ada-45e0-b85a-f351d1864235/users",
        "managers_url": "/v2/organizations/ef9fd3f7-9ada-45e0-b85a-f351d1864235/managers",
        "billing_managers_url": "/v2/organizations/ef9fd3f7-9ada-45e0-b85a-f351d1864235/billing_managers",
        "auditors_url": "/v2/organizations/ef9fd3f7-9ada-45e0-b85a-f351d1864235/auditors",
        "app_events_url": "/v2/organizations/ef9fd3f7-9ada-45e0-b85a-f351d1864235/app_events",
        "space_quota_definitions_url": "/v2/organizations/ef9fd3f7-9ada-45e0-b85a-f351d1864235/space_quota_definitions"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 8b943ad2-b19b-4c87-803c-5cd769e99bb9
Content-Length: 1520
X-Content-Type-Options: nosniff