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.eyJ1c2VyX2lkIjoidWFhLWlkLTM0MyIsImVtYWlsIjoiZW1haWwtMjY0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjI5OTA4ODV9.sQmQPU_7aPthZ38_sWdyZvzNuw_Rd28Cqq5BSlRgAqg
Host: example.org
Cookie: 

Route

GET /v2/organizations/70376ca3-d1c8-4ace-8057-df128e59a7dd/services

cURL

curl "https://api.[your-domain.com]/v2/organizations/70376ca3-d1c8-4ace-8057-df128e59a7dd/services" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM0MyIsImVtYWlsIjoiZW1haWwtMjY0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjI5OTA4ODV9.sQmQPU_7aPthZ38_sWdyZvzNuw_Rd28Cqq5BSlRgAqg" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: f49376d3-eb0b-49b0-bf7d-e22e028d9045
Content-Length: 1003
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "9589ae3d-6b6e-456a-ba12-7b3c73a3d552",
        "url": "/v2/services/9589ae3d-6b6e-456a-ba12-7b3c73a3d552",
        "created_at": "2015-01-27T19:14:45Z",
        "updated_at": null
      },
      "entity": {
        "label": "label-85",
        "provider": "provider-76",
        "url": "https://foo.com/url-106",
        "description": "desc-202",
        "long_description": null,
        "version": "version-60",
        "info_url": null,
        "active": true,
        "bindable": true,
        "unique_id": "275e3e0e-9fb8-430e-8477-504acb4fee7a",
        "extra": null,
        "tags": [

        ],
        "requires": [

        ],
        "documentation_url": null,
        "service_broker_guid": null,
        "plan_updateable": false,
        "service_plans_url": "/v2/services/9589ae3d-6b6e-456a-ba12-7b3c73a3d552/service_plans"
      }
    }
  ]
}