Skip to content
/
Get Service

Get Service

Request

Retrieve a Service for a Location as a JSON:API resource object.

Related data can be requested by repeating the include parameter, for example ?include=resources&include=company_links.

Security
BearerPartnerUser
Path
location_idintegerrequired

Location ID

service_idintegerrequired

Service ID

Query
includeArray of strings, unique

Related resources to include. The wire values are literal API keys: company_links contains Location-specific Service links.

Items Enum:"resources""service_composite""resource_links""company_links""trial_settings"
Headers
Acceptstringrequired

Required B2B v2 response media type. Use application/vnd.api.v2+json. A charset parameter is also accepted.

Default:"application/vnd.api.v2+json"
Example:application/vnd.api.v2+json
Authorizationstringrequired

Bearer {partner_token}, User {user_token}

curl -i -X GET \
  'https://developer.alteg.io/_mock/en/b2b-v2/openapi/locations/{location_id}/services/{service_id}?include=resources' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>'

Responses

Service retrieved successfully

Bodyapplication/json
dataobject(Service Resource)required
metaArray of any, <= 0 itemsrequired
includedArray of objects(includedResource)

Resources requested through include, when available

Response
{
  "data": {
    "type": "service",
    "id": "100",
    "attributes": { … }
  },
  "meta": []
}