GET /v2/organizations
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.eyJ1c2VyX2lkIjoidWFhLWlkLTExOCIsImVtYWlsIjoiZW1haWwtNjRAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ0MTY2MjU5OH0.AYPUCds3XBzu3bksswwoaiyiSzdYtQtLlwpAdBu0iMM Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/organizations" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTExOCIsImVtYWlsIjoiZW1haWwtNjRAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ0MTY2MjU5OH0.AYPUCds3XBzu3bksswwoaiyiSzdYtQtLlwpAdBu0iMM" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 1, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "ab56ba58-798d-405d-923a-6c0a836b9bb7", "url": "/v2/organizations/ab56ba58-798d-405d-923a-6c0a836b9bb7", "created_at": "2015-08-31T21:49:52Z", "updated_at": null }, "entity": { "name": "the-system_domain-org-name", "billing_enabled": false, "quota_definition_guid": "e85472e6-ee5b-4739-a074-79f5f85c28d2", "status": "active", "quota_definition_url": "/v2/quota_definitions/e85472e6-ee5b-4739-a074-79f5f85c28d2", "spaces_url": "/v2/organizations/ab56ba58-798d-405d-923a-6c0a836b9bb7/spaces", "domains_url": "/v2/organizations/ab56ba58-798d-405d-923a-6c0a836b9bb7/domains", "private_domains_url": "/v2/organizations/ab56ba58-798d-405d-923a-6c0a836b9bb7/private_domains", "users_url": "/v2/organizations/ab56ba58-798d-405d-923a-6c0a836b9bb7/users", "managers_url": "/v2/organizations/ab56ba58-798d-405d-923a-6c0a836b9bb7/managers", "billing_managers_url": "/v2/organizations/ab56ba58-798d-405d-923a-6c0a836b9bb7/billing_managers", "auditors_url": "/v2/organizations/ab56ba58-798d-405d-923a-6c0a836b9bb7/auditors", "app_events_url": "/v2/organizations/ab56ba58-798d-405d-923a-6c0a836b9bb7/app_events", "space_quota_definitions_url": "/v2/organizations/ab56ba58-798d-405d-923a-6c0a836b9bb7/space_quota_definitions" } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: e2b3f31a-7a73-4234-8666-d6e9a9fc47bb Content-Length: 1520 X-Content-Type-Options: nosniff