PEAK Get Service icon

PEAK Get Service

Send parameter to get service via PEAK API

PEAK Get Service

AI-generated

Summary

Retrieves service details from the PEAK API based on a specified server environment and optional Service ID or Code, authenticated with a user token and HMAC signature.

Inputs

  • serverEnvironment (required) — The server environment to query: 'uat' or 'production'.
  • serviceId — The Service ID to filter the request.
  • serviceCode — The Service Code to filter the request.
  • clientTokenOverride — Optional Client Token to use instead of the one from credentials.

Output shape

A list of items, each containing the API response wrapped in a JSON object with success status, status code, original data, and headers.

If an error occurs and continue on error is enabled, an item with an 'error' property is returned.

Examples

Example 1: Fetch a specific service from production by ID

Server Environment: Production, Service ID: 12345

Example 2: Search for services using a code in the UAT environment

Server Environment: UAT, Service Code: MY-CODE-001

Links

Discussion