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.eyJ1c2VyX2lkIjoidWFhLWlkLTI0OSIsImVtYWlsIjoiZW1haWwtMTg5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjIzMjM1NDl9.3Ff0bF8YcMr_uNA9iawlBoWdycC7cUTy4QuuqHRmnYg
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.eyJ1c2VyX2lkIjoidWFhLWlkLTI0OSIsImVtYWlsIjoiZW1haWwtMTg5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjIzMjM1NDl9.3Ff0bF8YcMr_uNA9iawlBoWdycC7cUTy4QuuqHRmnYg" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 43b1c941-d889-4b00-b665-741abc57662b
Content-Length: 701
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "52360ff2-eddc-4c43-b90d-6c39ac2e0ec1",
        "url": "/v2/service_plan_visibilities/52360ff2-eddc-4c43-b90d-6c39ac2e0ec1",
        "created_at": "2015-01-20T01:52:29+00:00",
        "updated_at": null
      },
      "entity": {
        "service_plan_guid": "1631e720-e5ef-4b7f-8386-3eaa21c0ade2",
        "organization_guid": "21a2a83d-882a-4f1a-aa5a-aaa24e30dcbf",
        "service_plan_url": "/v2/service_plans/1631e720-e5ef-4b7f-8386-3eaa21c0ade2",
        "organization_url": "/v2/organizations/21a2a83d-882a-4f1a-aa5a-aaa24e30dcbf"
      }
    }
  ]
}