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.eyJ1c2VyX2lkIjoidWFhLWlkLTMyMiIsImVtYWlsIjoiZW1haWwtMjI1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDQ3ODI5NDF9.kLDzZaQ22yc6uSBykPD-FohHqnE5WEEm44xEgrEwQAM Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/organizations" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMyMiIsImVtYWlsIjoiZW1haWwtMjI1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDQ3ODI5NDF9.kLDzZaQ22yc6uSBykPD-FohHqnE5WEEm44xEgrEwQAM" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 1, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "5ea42db0-9b13-4c8c-8ea9-c11453321a44", "url": "/v2/organizations/5ea42db0-9b13-4c8c-8ea9-c11453321a44", "created_at": "2015-10-07T00:35:26Z", "updated_at": null }, "entity": { "name": "the-system_domain-org-name", "billing_enabled": false, "quota_definition_guid": "77a28e0c-d64d-45c0-a8eb-4df759502c95", "status": "active", "quota_definition_url": "/v2/quota_definitions/77a28e0c-d64d-45c0-a8eb-4df759502c95", "spaces_url": "/v2/organizations/5ea42db0-9b13-4c8c-8ea9-c11453321a44/spaces", "domains_url": "/v2/organizations/5ea42db0-9b13-4c8c-8ea9-c11453321a44/domains", "private_domains_url": "/v2/organizations/5ea42db0-9b13-4c8c-8ea9-c11453321a44/private_domains", "users_url": "/v2/organizations/5ea42db0-9b13-4c8c-8ea9-c11453321a44/users", "managers_url": "/v2/organizations/5ea42db0-9b13-4c8c-8ea9-c11453321a44/managers", "billing_managers_url": "/v2/organizations/5ea42db0-9b13-4c8c-8ea9-c11453321a44/billing_managers", "auditors_url": "/v2/organizations/5ea42db0-9b13-4c8c-8ea9-c11453321a44/auditors", "app_events_url": "/v2/organizations/5ea42db0-9b13-4c8c-8ea9-c11453321a44/app_events", "space_quota_definitions_url": "/v2/organizations/5ea42db0-9b13-4c8c-8ea9-c11453321a44/space_quota_definitions" } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: c4b6092a-33d7-4d86-a7cf-53a77fb99e98 Content-Length: 1520 X-Content-Type-Options: nosniff