Home
Version 3
Organizations API

Organizations API

List all Spaces for the Organization

GET /v2/organizations/:guid/spaces

Fields

Name Description Default Valid Values Example Values

Parameters

Name Description Valid Values Example Values
guid The guid of the Organization
q Parameters used to filter the result set.
Format queries as <filter><op><value>
Valid ops: : >= <= < > IN
Valid filters: name, organization_guid, developer_guid, app_guid
  • q=filter:value
  • q=filter>value
  • q=filter IN a,b,c
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.

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIxMCIsImVtYWlsIjoiZW1haWwtMTU0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTU3NTQxNDJ9.MAxZ-Rbgn2Kncp4lg7A-cjD_pUpGT8gMbDsBShJFz24
Host: example.org
Cookie:

Route

GET /v2/organizations/01e997b9-b32f-4501-9800-8434d21cff5b/spaces

cURL

curl "https://api.[your-domain.com]/v2/organizations/01e997b9-b32f-4501-9800-8434d21cff5b/spaces" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIxMCIsImVtYWlsIjoiZW1haWwtMTU0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTU3NTQxNDJ9.MAxZ-Rbgn2Kncp4lg7A-cjD_pUpGT8gMbDsBShJFz24" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 2fb04e61-d43c-4a38-a148-6a842724e05f
Content-Length: 1462
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "aa0aa616-a450-4fe8-b60f-1e92c06c704d",
        "url": "/v2/spaces/aa0aa616-a450-4fe8-b60f-1e92c06c704d",
        "created_at": "2014-11-05T01:02:22+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "name-762",
        "organization_guid": "01e997b9-b32f-4501-9800-8434d21cff5b",
        "space_quota_definition_guid": null,
        "organization_url": "/v2/organizations/01e997b9-b32f-4501-9800-8434d21cff5b",
        "developers_url": "/v2/spaces/aa0aa616-a450-4fe8-b60f-1e92c06c704d/developers",
        "managers_url": "/v2/spaces/aa0aa616-a450-4fe8-b60f-1e92c06c704d/managers",
        "auditors_url": "/v2/spaces/aa0aa616-a450-4fe8-b60f-1e92c06c704d/auditors",
        "apps_url": "/v2/spaces/aa0aa616-a450-4fe8-b60f-1e92c06c704d/apps",
        "routes_url": "/v2/spaces/aa0aa616-a450-4fe8-b60f-1e92c06c704d/routes",
        "domains_url": "/v2/spaces/aa0aa616-a450-4fe8-b60f-1e92c06c704d/domains",
        "service_instances_url": "/v2/spaces/aa0aa616-a450-4fe8-b60f-1e92c06c704d/service_instances",
        "app_events_url": "/v2/spaces/aa0aa616-a450-4fe8-b60f-1e92c06c704d/app_events",
        "events_url": "/v2/spaces/aa0aa616-a450-4fe8-b60f-1e92c06c704d/events",
        "security_groups_url": "/v2/spaces/aa0aa616-a450-4fe8-b60f-1e92c06c704d/security_groups"
      }
    }
  ]
}