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.eyJ1c2VyX2lkIjoidWFhLWlkLTI1NSIsImVtYWlsIjoiZW1haWwtMTk1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQzMTAxMzV9.ecH9IVlQeN6nDkYsAty5FtklhvHd7tv43AiBg6--4qU
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.eyJ1c2VyX2lkIjoidWFhLWlkLTI1NSIsImVtYWlsIjoiZW1haWwtMTk1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQzMTAxMzV9.ecH9IVlQeN6nDkYsAty5FtklhvHd7tv43AiBg6--4qU" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 4b709ac3-6a23-495c-9230-5f25fd878ed1
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": "753b915b-a35f-4a24-bbce-316330bea74b",
        "url": "/v2/service_plan_visibilities/753b915b-a35f-4a24-bbce-316330bea74b",
        "created_at": "2015-02-12T01:42:15Z",
        "updated_at": null
      },
      "entity": {
        "service_plan_guid": "16f4fb84-e829-4e58-bd76-c5a569b5c115",
        "organization_guid": "49ec8a49-5acb-48d5-818b-b1b2c5117b61",
        "service_plan_url": "/v2/service_plans/16f4fb84-e829-4e58-bd76-c5a569b5c115",
        "organization_url": "/v2/organizations/49ec8a49-5acb-48d5-818b-b1b2c5117b61"
      }
    }
  ]
}