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. |
|
|
Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIwNSIsImVtYWlsIjoiZW1haWwtMTQ5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTU3NTQxNDF9.cO9nc_Up17nScVbLfQbht31v0lLwPOoewq9auR3Tzmw Host: example.org Cookie:
GET /v2/organizations
curl "https://api.[your-domain.com]/v2/organizations" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIwNSIsImVtYWlsIjoiZW1haWwtMTQ5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTU3NTQxNDF9.cO9nc_Up17nScVbLfQbht31v0lLwPOoewq9auR3Tzmw" \ -H "Host: example.org" \ -H "Cookie: "
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: 511dcdb9-b8c6-4e12-b8c5-450a24c15400 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": "45d39e6a-3d94-47c7-93c5-fac8bf5131b1", "url": "/v2/organizations/45d39e6a-3d94-47c7-93c5-fac8bf5131b1", "created_at": "2014-11-05T01:02:07+00:00", "updated_at": null }, "entity": { "name": "the-system_domain-org-name", "billing_enabled": false, "quota_definition_guid": "aa184601-7350-474f-a89d-3665084b47ad", "status": "active", "quota_definition_url": "/v2/quota_definitions/aa184601-7350-474f-a89d-3665084b47ad", "spaces_url": "/v2/organizations/45d39e6a-3d94-47c7-93c5-fac8bf5131b1/spaces", "domains_url": "/v2/organizations/45d39e6a-3d94-47c7-93c5-fac8bf5131b1/domains", "private_domains_url": "/v2/organizations/45d39e6a-3d94-47c7-93c5-fac8bf5131b1/private_domains", "users_url": "/v2/organizations/45d39e6a-3d94-47c7-93c5-fac8bf5131b1/users", "managers_url": "/v2/organizations/45d39e6a-3d94-47c7-93c5-fac8bf5131b1/managers", "billing_managers_url": "/v2/organizations/45d39e6a-3d94-47c7-93c5-fac8bf5131b1/billing_managers", "auditors_url": "/v2/organizations/45d39e6a-3d94-47c7-93c5-fac8bf5131b1/auditors", "app_events_url": "/v2/organizations/45d39e6a-3d94-47c7-93c5-fac8bf5131b1/app_events", "space_quota_definitions_url": "/v2/organizations/45d39e6a-3d94-47c7-93c5-fac8bf5131b1/space_quota_definitions" } } ] }