Home
Version 3
Organizations API

Organizations API

List all Services for the Organization

GET /v2/organizations/:guid/services

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: active, label, provider, service_broker_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.
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

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIwNCIsImVtYWlsIjoiZW1haWwtMTQ4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTY1MjY3MDV9.Ep6_z4oLD8Oo0YPVQ43Sd1-KOXkMRxtZhnQJdfPHqVw
Host: example.org
Cookie: 

Route

GET /v2/organizations/59855b0e-ec32-4dab-a97b-d2b79afa8839/services

cURL

curl "https://api.[your-domain.com]/v2/organizations/59855b0e-ec32-4dab-a97b-d2b79afa8839/services" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIwNCIsImVtYWlsIjoiZW1haWwtMTQ4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTY1MjY3MDV9.Ep6_z4oLD8Oo0YPVQ43Sd1-KOXkMRxtZhnQJdfPHqVw" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: d3bca6b8-2210-4207-9626-63d291e2f5e8
Content-Length: 1006
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "b29d45bd-79fd-4fbb-ad0a-62024cd4ee64",
        "url": "/v2/services/b29d45bd-79fd-4fbb-ad0a-62024cd4ee64",
        "created_at": "2014-11-13T23:38:25+00:00",
        "updated_at": null
      },
      "entity": {
        "label": "label-42",
        "provider": "provider-33",
        "url": "https://foo.com/url-44",
        "description": "desc-40",
        "long_description": null,
        "version": "version-17",
        "info_url": null,
        "active": true,
        "bindable": true,
        "unique_id": "3e329255-5e56-414d-8c59-9e2b2dbeaf0d",
        "extra": null,
        "tags": [

        ],
        "requires": [

        ],
        "documentation_url": null,
        "service_broker_guid": null,
        "plan_updateable": false,
        "service_plans_url": "/v2/services/b29d45bd-79fd-4fbb-ad0a-62024cd4ee64/service_plans"
      }
    }
  ]
}