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.eyJ1c2VyX2lkIjoidWFhLWlkLTEzNSIsImVtYWlsIjoiZW1haWwtMTA4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTc0NjIzNTh9.8kHtd7iw0TGmUzB1lMUl-UO1EX9ZV0cLSI_fIWPst0g Host: example.org Cookie:
GET /v2/organizations
curl "https://api.[your-domain.com]/v2/organizations" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEzNSIsImVtYWlsIjoiZW1haWwtMTA4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTc0NjIzNTh9.8kHtd7iw0TGmUzB1lMUl-UO1EX9ZV0cLSI_fIWPst0g" \ -H "Host: example.org" \ -H "Cookie: "
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: a5a1c9a3-de78-4ecd-b84b-483c8e065752 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": "7be909b4-f1f1-4641-bad0-97110814bd64", "url": "/v2/organizations/7be909b4-f1f1-4641-bad0-97110814bd64", "created_at": "2014-11-24T19:32:34+00:00", "updated_at": null }, "entity": { "name": "the-system_domain-org-name", "billing_enabled": false, "quota_definition_guid": "52c5c208-6444-4b2e-8f02-909104b3aa0a", "status": "active", "quota_definition_url": "/v2/quota_definitions/52c5c208-6444-4b2e-8f02-909104b3aa0a", "spaces_url": "/v2/organizations/7be909b4-f1f1-4641-bad0-97110814bd64/spaces", "domains_url": "/v2/organizations/7be909b4-f1f1-4641-bad0-97110814bd64/domains", "private_domains_url": "/v2/organizations/7be909b4-f1f1-4641-bad0-97110814bd64/private_domains", "users_url": "/v2/organizations/7be909b4-f1f1-4641-bad0-97110814bd64/users", "managers_url": "/v2/organizations/7be909b4-f1f1-4641-bad0-97110814bd64/managers", "billing_managers_url": "/v2/organizations/7be909b4-f1f1-4641-bad0-97110814bd64/billing_managers", "auditors_url": "/v2/organizations/7be909b4-f1f1-4641-bad0-97110814bd64/auditors", "app_events_url": "/v2/organizations/7be909b4-f1f1-4641-bad0-97110814bd64/app_events", "space_quota_definitions_url": "/v2/organizations/7be909b4-f1f1-4641-bad0-97110814bd64/space_quota_definitions" } } ] }