---
title: "Get product by product external ID"
method: GET
path: "/v1/api/products/{productExternalId}"
tags: ["Products"]
---

# Get product by product external ID

`GET /v1/api/products/{productExternalId}`

## Request

- Base URL: `http://products_url`
- URL: `http://products_url/v1/api/products/{productExternalId}`
- Auth: none declared

## Path parameters

- `productExternalId` string, required

## Response `200`

OK

- Product
  - `_links` Link[]
    - `href` string
    - `method` string
    - `rel` 'self' | 'pay' | 'next' | 'friendly'
  - `amount_hint` string
  - `date_created` string, date-time
  - `description` string
  - `external_id` string
  - `gateway_account_id` integer
  - `language` 'en' | 'cy'
  - `metadata` object
  - `name` string
  - `pay_api_token` string
  - `price` integer
  - `product_name_path` string
  - `reference_enabled` boolean
  - `reference_hint` string
  - `reference_label` string
  - `require_captcha` boolean
  - `return_url` string
  - `service_name_path` string
  - `status` 'ACTIVE' | 'INACTIVE'
  - `type` 'DEMO' | 'PROTOTYPE' | 'ADHOC' | 'AGENT_INITIATED_MOTO'

## Other responses

- `404`: Not found

## Changes

- **2025-08-04** `521f70c3f2d9`: 1 info
  - added the optional property `date_created` to the response with the `200` status
- **2023-01-05** `7a993ebe4a85`: 1 info
  - added the optional property `pay_api_token` to the response with the `200` status
- **2022-08-30** `16f0bb4aa3cf`: 1 warning
  - removed the optional property `new_payment_link_journey_enabled` from the response with the `200` status
- **2022-04-05** `9ffbc14fb6d4`: 1 info
  - added the optional property `amount_hint` to the response with the `200` status

[Operation history](https://skmtc.dev/government-digital-service/apis/products-api/changes/v1/api/products/:productExternalId/get.md)

---

[API](https://skmtc.dev/government-digital-service/apis/products-api.md) - [All operations](https://skmtc.dev/government-digital-service/apis/products-api/llms.txt) - [OpenAPI document](https://skmtc.dev/government-digital-service/apis/products-api/revisions/521f70c3f2d9?raw)