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.eyJ1c2VyX2lkIjoidWFhLWlkLTYwIiwiZW1haWwiOiJlbWFpbC02MEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDM5NDI2MTk2fQ.nnSlkXfN8Bpfym6phUB3OqHaAWHwhtO_h8_rikh3D_8 Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/organizations" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTYwIiwiZW1haWwiOiJlbWFpbC02MEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDM5NDI2MTk2fQ.nnSlkXfN8Bpfym6phUB3OqHaAWHwhtO_h8_rikh3D_8" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 1, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "8cfefa96-7690-4e9b-972f-9145381aa8ab", "url": "/v2/organizations/8cfefa96-7690-4e9b-972f-9145381aa8ab", "created_at": "2015-08-06T00:36:30Z", "updated_at": null }, "entity": { "name": "the-system_domain-org-name", "billing_enabled": false, "quota_definition_guid": "85851c62-c2b6-4ae0-a7fa-d72f957d6d29", "status": "active", "quota_definition_url": "/v2/quota_definitions/85851c62-c2b6-4ae0-a7fa-d72f957d6d29", "spaces_url": "/v2/organizations/8cfefa96-7690-4e9b-972f-9145381aa8ab/spaces", "domains_url": "/v2/organizations/8cfefa96-7690-4e9b-972f-9145381aa8ab/domains", "private_domains_url": "/v2/organizations/8cfefa96-7690-4e9b-972f-9145381aa8ab/private_domains", "users_url": "/v2/organizations/8cfefa96-7690-4e9b-972f-9145381aa8ab/users", "managers_url": "/v2/organizations/8cfefa96-7690-4e9b-972f-9145381aa8ab/managers", "billing_managers_url": "/v2/organizations/8cfefa96-7690-4e9b-972f-9145381aa8ab/billing_managers", "auditors_url": "/v2/organizations/8cfefa96-7690-4e9b-972f-9145381aa8ab/auditors", "app_events_url": "/v2/organizations/8cfefa96-7690-4e9b-972f-9145381aa8ab/app_events", "space_quota_definitions_url": "/v2/organizations/8cfefa96-7690-4e9b-972f-9145381aa8ab/space_quota_definitions" } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: 976dc451-ce5d-4c2f-891c-025a202bbd0c Content-Length: 1520 X-Content-Type-Options: nosniff