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.eyJ1c2VyX2lkIjoidWFhLWlkLTg4IiwiZW1haWwiOiJlbWFpbC02N0Bzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDMyNzc0OTgyfQ.LitibQ3L1SQuZoQI_XZ-Xed30cW6lxDKtnFFimJr_n4
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/organizations" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTg4IiwiZW1haWwiOiJlbWFpbC02N0Bzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDMyNzc0OTgyfQ.LitibQ3L1SQuZoQI_XZ-Xed30cW6lxDKtnFFimJr_n4" \
	-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": "038611b9-a464-47c9-ace9-f11dbd4c55d4",
        "url": "/v2/organizations/038611b9-a464-47c9-ace9-f11dbd4c55d4",
        "created_at": "2015-05-21T01:03:00Z",
        "updated_at": null
      },
      "entity": {
        "name": "the-system_domain-org-name",
        "billing_enabled": false,
        "quota_definition_guid": "6163a53e-00b7-4d51-96ee-6883981334eb",
        "status": "active",
        "quota_definition_url": "/v2/quota_definitions/6163a53e-00b7-4d51-96ee-6883981334eb",
        "spaces_url": "/v2/organizations/038611b9-a464-47c9-ace9-f11dbd4c55d4/spaces",
        "domains_url": "/v2/organizations/038611b9-a464-47c9-ace9-f11dbd4c55d4/domains",
        "private_domains_url": "/v2/organizations/038611b9-a464-47c9-ace9-f11dbd4c55d4/private_domains",
        "users_url": "/v2/organizations/038611b9-a464-47c9-ace9-f11dbd4c55d4/users",
        "managers_url": "/v2/organizations/038611b9-a464-47c9-ace9-f11dbd4c55d4/managers",
        "billing_managers_url": "/v2/organizations/038611b9-a464-47c9-ace9-f11dbd4c55d4/billing_managers",
        "auditors_url": "/v2/organizations/038611b9-a464-47c9-ace9-f11dbd4c55d4/auditors",
        "app_events_url": "/v2/organizations/038611b9-a464-47c9-ace9-f11dbd4c55d4/app_events",
        "space_quota_definitions_url": "/v2/organizations/038611b9-a464-47c9-ace9-f11dbd4c55d4/space_quota_definitions"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: d492b47b-76ca-4be3-88a4-5945be7dd299
Content-Length: 1520
X-Content-Type-Options: nosniff