Name | Description | Default | Valid Values | Example Values |
---|
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 |
|
|
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 |
|
|
Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEwIiwiZW1haWwiOiJlbWFpbC0xMEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI0NDcxNjg1fQ.xn7rt2mE7t51iiCAm7GM8sDOG6345lswVi7X_3gRhFM Host: example.org Cookie:
GET /v2/organizations
curl "https://api.[your-domain.com]/v2/organizations" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEwIiwiZW1haWwiOiJlbWFpbC0xMEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI0NDcxNjg1fQ.xn7rt2mE7t51iiCAm7GM8sDOG6345lswVi7X_3gRhFM" \ -H "Host: example.org" \ -H "Cookie: "
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: 35844707-1adf-4872-a70a-f0e2204783d5 Content-Length: 1520 X-Content-Type-Options: nosniff
200 OK
{ "total_results": 1, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "cd4f4314-4ddb-40ce-968d-9bc294719246", "url": "/v2/organizations/cd4f4314-4ddb-40ce-968d-9bc294719246", "created_at": "2015-02-13T22:34:45Z", "updated_at": null }, "entity": { "name": "the-system_domain-org-name", "billing_enabled": false, "quota_definition_guid": "76479ca8-daf1-40bb-9396-20e59ef01e3a", "status": "active", "quota_definition_url": "/v2/quota_definitions/76479ca8-daf1-40bb-9396-20e59ef01e3a", "spaces_url": "/v2/organizations/cd4f4314-4ddb-40ce-968d-9bc294719246/spaces", "domains_url": "/v2/organizations/cd4f4314-4ddb-40ce-968d-9bc294719246/domains", "private_domains_url": "/v2/organizations/cd4f4314-4ddb-40ce-968d-9bc294719246/private_domains", "users_url": "/v2/organizations/cd4f4314-4ddb-40ce-968d-9bc294719246/users", "managers_url": "/v2/organizations/cd4f4314-4ddb-40ce-968d-9bc294719246/managers", "billing_managers_url": "/v2/organizations/cd4f4314-4ddb-40ce-968d-9bc294719246/billing_managers", "auditors_url": "/v2/organizations/cd4f4314-4ddb-40ce-968d-9bc294719246/auditors", "app_events_url": "/v2/organizations/cd4f4314-4ddb-40ce-968d-9bc294719246/app_events", "space_quota_definitions_url": "/v2/organizations/cd4f4314-4ddb-40ce-968d-9bc294719246/space_quota_definitions" } } ] }