Skip to content
/
List Services

List Services

Request

Retrieve Services for a Location, optionally filtered by Service IDs.

The response uses JSON:API resource objects. Pagination uses page and limit; pagination metadata is not returned.

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

Security
BearerPartnerUser
Path
location_idintegerrequired

Location ID

Query
filter[service_ids][]Array of integers

Filter by Service IDs

pageinteger, >= 1

Page number

Default:1
limitinteger, [ 1 .. 250 ]

Maximum number of Services to return

Default:250
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?filter%5Bservice_ids%5D%5B%5D=1&page=1&limit=250&include=resources' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>'

Responses

Services retrieved successfully

Bodyapplication/json
dataArray of objects(Service Resource)required
includedArray of objects(includedResource)

Resources requested through include, when available

Response
{
  "data": [
    { … }
  ]
}