API Reference Organization Service Facilities V2

Get all organization service facilities

Beta

GET

Query parameters

limitintegerOptional

Limit the number of results returned. Defaults to 100.

namestringOptional

Filter to a name or a part of a name.

page_tokenstringOptional

The page token to continue paging through a previous request.

Response

This endpoint returns an object.

itemslist of objects

next_page_tokenstringOptional

prev_page_tokenstringOptional

GET

1 curl -G https://api.joincandidhealth.com/api/organization-service-facilities/v2 \
2      -H "Authorization: Bearer <token>" \
3      -d limit=100 \
4      --data-urlencode name="Test Service Facility" \
5      -d page_token=eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9

200Retrieved

1 {
2   "items": [
3     {
4       "organization_service_facility_id": "30F55EE6-8C0E-43FC-A7FC-DAC00D5BF569",
5       "name": "Test Service Facility",
6       "aliases": [
7         "Test Service Facility Alias"
8       ],
9       "description": "Test Service Facility Description",
10       "status": "active",
11       "operational_status": "C",
12       "mode": "instance",
13       "type": "DX",
14       "physical_type": "si",
15       "telecoms": [
16         "555-555-5555"
17       ],
18       "address": {
19         "address1": "123 Main St",
20         "address2": "Apt 1",
21         "city": "New York",
22         "state": "NY",
23         "zip_code": "10001",
24         "zip_plus_four_code": "1234"
25       }
26     }
27   ]
28 }

Built with

1	curl -G https://api.joincandidhealth.com/api/organization-service-facilities/v2 \
2	-H "Authorization: Bearer <token>" \
3	-d limit=100 \
4	--data-urlencode name="Test Service Facility" \
5	-d page_token=eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9

1	{
2	"items": [
3	{
4	"organization_service_facility_id": "30F55EE6-8C0E-43FC-A7FC-DAC00D5BF569",
5	"name": "Test Service Facility",
6	"aliases": [
7	"Test Service Facility Alias"
8	],
9	"description": "Test Service Facility Description",
10	"status": "active",
11	"operational_status": "C",
12	"mode": "instance",
13	"type": "DX",
14	"physical_type": "si",
15	"telecoms": [
16	"555-555-5555"
17	],
18	"address": {
19	"address1": "123 Main St",
20	"address2": "Apt 1",
21	"city": "New York",
22	"state": "NY",
23	"zip_code": "10001",
24	"zip_plus_four_code": "1234"
25	}
26	}
27	]
28	}