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.eyJ1c2VyX2lkIjoidWFhLWlkLTMzNSIsImVtYWlsIjoiZW1haWwtMjU2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjIzMjM1NTN9.pLkYZls__JfUOc1rYf-Oc6lWQKWEMzYVWfAAj02-LLc Host: example.org Cookie:
GET /v2/organizations
curl "https://api.[your-domain.com]/v2/organizations" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMzNSIsImVtYWlsIjoiZW1haWwtMjU2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjIzMjM1NTN9.pLkYZls__JfUOc1rYf-Oc6lWQKWEMzYVWfAAj02-LLc" \ -H "Host: example.org" \ -H "Cookie: "
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: 3bb33f7c-4ddb-426e-87df-d1aab161e9d6 Content-Length: 1525 X-Content-Type-Options: nosniff
200 OK
{ "total_results": 1, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "0468a4c0-e364-4d6d-b90a-4b5a27be9092", "url": "/v2/organizations/0468a4c0-e364-4d6d-b90a-4b5a27be9092", "created_at": "2015-01-20T01:52:15+00:00", "updated_at": null }, "entity": { "name": "the-system_domain-org-name", "billing_enabled": false, "quota_definition_guid": "7c8d6013-deed-4c98-bd06-fbc0c1d28d11", "status": "active", "quota_definition_url": "/v2/quota_definitions/7c8d6013-deed-4c98-bd06-fbc0c1d28d11", "spaces_url": "/v2/organizations/0468a4c0-e364-4d6d-b90a-4b5a27be9092/spaces", "domains_url": "/v2/organizations/0468a4c0-e364-4d6d-b90a-4b5a27be9092/domains", "private_domains_url": "/v2/organizations/0468a4c0-e364-4d6d-b90a-4b5a27be9092/private_domains", "users_url": "/v2/organizations/0468a4c0-e364-4d6d-b90a-4b5a27be9092/users", "managers_url": "/v2/organizations/0468a4c0-e364-4d6d-b90a-4b5a27be9092/managers", "billing_managers_url": "/v2/organizations/0468a4c0-e364-4d6d-b90a-4b5a27be9092/billing_managers", "auditors_url": "/v2/organizations/0468a4c0-e364-4d6d-b90a-4b5a27be9092/auditors", "app_events_url": "/v2/organizations/0468a4c0-e364-4d6d-b90a-4b5a27be9092/app_events", "space_quota_definitions_url": "/v2/organizations/0468a4c0-e364-4d6d-b90a-4b5a27be9092/space_quota_definitions" } } ] }