Home
Version 3
Service Plan Visibilities API

Service Plan Visibilities API

List all Service Plan Visibilities

GET /v2/service_plan_visibilities

Fields

Name Description Default Valid Values Example Values

Parameters

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: organization_guid, service_plan_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.eyJ1c2VyX2lkIjoidWFhLWlkLTMwOSIsImVtYWlsIjoiZW1haWwtMjEyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQxMzczNzR9.TkY3lnzjiehlhPYagY70LS14ZX3UgIjw-wvthrU9JyM
Host: example.org
Cookie:

Route

GET /v2/service_plan_visibilities

cURL

curl "https://api.[your-domain.com]/v2/service_plan_visibilities" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMwOSIsImVtYWlsIjoiZW1haWwtMjEyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQxMzczNzR9.TkY3lnzjiehlhPYagY70LS14ZX3UgIjw-wvthrU9JyM" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: ded6131d-fd37-4f78-8cce-3035fbd6dcbe
Content-Length: 696
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "66b9ef0b-3ebc-45bd-acbe-a21a10b51f1c",
        "url": "/v2/service_plan_visibilities/66b9ef0b-3ebc-45bd-acbe-a21a10b51f1c",
        "created_at": "2015-02-10T01:42:54Z",
        "updated_at": null
      },
      "entity": {
        "service_plan_guid": "ca363d0d-32c5-4236-b608-840eb1a22dd8",
        "organization_guid": "f188ac16-1523-4b96-96f8-1c8366a362d7",
        "service_plan_url": "/v2/service_plans/ca363d0d-32c5-4236-b608-840eb1a22dd8",
        "organization_url": "/v2/organizations/f188ac16-1523-4b96-96f8-1c8366a362d7"
      }
    }
  ]
}