---
title: "Get Customer by ID"
method: GET
path: "/v2/shops/{shop_identifier}/customers/{id}"
tags: ["Customers"]
---

# Get Customer by ID

`GET /v2/shops/{shop_identifier}/customers/{id}`

## Request

- Base URL: `http://customer-api.prod.svc.cluster.local:9000`
- URL: `http://customer-api.prod.svc.cluster.local:9000/v2/shops/{shop_identifier}/customers/{id}`
- Auth: none declared
- TypeScript: <https://skmtc.dev/boldcommerce/apis/internal-customers-service/docs/v2/shops/:shop_identifier/customers/:id/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves a customer by the Bold-generated ID.

## Path parameters

- `shop_identifier` string, required
- `id` integer, required

## Response `200`

A successful response.

- V2CustomerByXIDResponse
  - `customer` V2Customer
    - `tags` string: A comma-separated list of tags that describe the customer.
    - `deleted_at` string, date-time, nullable: The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) the customer was deleted. This value is `null` if the customer was not deleted.
    - `shop_identifier` string: The unique identifier for the store. Retrieve this information by calling the [Get Shop Info](shops#tag/Shop/operation/GetShopInfo) endpoint.
    - `platform_created_at` string, date-time: The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) the customer was created on the platform.
    - `id` integer: The unique, Bold-generated identifier for the customer.
    - `platform_type` string: The ecommerce platform associated with the store.
    - `last_name` string: The customer's last name.
    - `first_name` string: The customer's first name.
    - `labels` Customersv2Label[]: An array of customer labels.
      - `id` integer: The identifier for the label.
      - `customer_id` integer: The identifier for the customer that the label applies to.
      - `name` string: The name of the label.
      - `created_at` string, date-time: The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) the label was created.
      - `updated_at` string, date-time, nullable: The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) the label was updated. If the label was not updated, this value is the same as `created_at`.
      - `deleted_at` string, date-time, nullable: The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) the label was deleted. This value is `null` if the label was never deleted.
    - `groups` V2Group[]: An array of groups that the customer belongs to. Groups denote relationships between customer data. Supported for BigCommerce and Shopify only.
      - `id` integer: The identifier for the group.
      - `name` string: The name of the group.
      - `description` string: The description of the group.
      - `shop_identifier` string: The unique identifier for the store. Retrieve this information by calling the [Get Shop Info](shops#tag/Shop/operation/GetShopInfo) endpoint.
      - `platform_id` string: The platform-generated identifier for the group.
      - `created_at` string, date-time: The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) the group was created.
      - `updated_at` string, date-time, nullable: The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) the group was updated. If the group was not updated, this value is the same as `created_at`.
      - `deleted_at` string, date-time, nullable: The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) the group was deleted. This value is `null` if the group was not deleted.
    - `updated_at` string, date-time, nullable: The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) the customer was updated. If the customer was not updated, this value is the same as `platform_created_at`.
    - `phone` string: The customer's phone number.
    - `platform_id` string: The platform-defined identifier for the customer.
    - `addresses` V2Address[]: The list of addresses associated with the customer, limited to the first 50 found.
      - `city` string: The city name.
      - `province` string: The province name.
      - `province_code` string: The province code (in [ISO-3166 format](https://www.iso.org/iso-3166-country-codes.html)).
      - `country` string: The country name.
      - `created_at` string, date-time: The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) the address was created.
      - `zip` string: The zip/postal code of the address.
      - `address_type` string: The type of address (i.e., residential, commercial).
      - `platform_customer_id` string: The platform-defined identifier for the customer.
      - `deleted_at` string, date-time, nullable: The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) the address was deleted. This value is `null` if the address was not deleted.
      - `address_use` 'shipping' | 'billing': The type of address.
      - `company` string: The company name (if applicable).
      - `street_2` string: Any additional address details (if applicable).
      - `platform_id` string: A platform-generated identifier for the address.
      - `shop_identifier` string: The unique identifier for the store. Retrieve this information by calling the [Get Shop Info](shops#tag/Shop/operation/GetShopInfo) endpoint.
      - `platform_type` string: The ecommerce platform associated with the store.
      - `first_name` string: The customer's first name.
      - `address_source` 'platform' | 'bold': The location the address was created.
      - `last_name` string: The customer's last name.
      - `updated_at` string, date-time: The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) the address was updated. If this value was not updated, it is set to the same value as `created_at`.
      - `phone` string: The customer's phone number.
      - `is_default` boolean: Indicates whether the address is set as the customer's default.
      - `bold_customer_id` integer: The unique, Bold-generated identifier for the customer.
      - `country_iso2` string: The country code, in [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) format.
      - `street_1` string: The street address.
      - `id` integer: The unique, Bold-generated identifier for the address.
    - `created_at` string, date-time: The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) the customer was created.
    - `email` string: The customer's email.
    - `default_address` V2Address
      - `city` string: The city name.
      - `province` string: The province name.
      - `province_code` string: The province code (in [ISO-3166 format](https://www.iso.org/iso-3166-country-codes.html)).
      - `country` string: The country name.
      - `created_at` string, date-time: The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) the address was created.
      - `zip` string: The zip/postal code of the address.
      - `address_type` string: The type of address (i.e., residential, commercial).
      - `platform_customer_id` string: The platform-defined identifier for the customer.
      - `deleted_at` string, date-time, nullable: The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) the address was deleted. This value is `null` if the address was not deleted.
      - `address_use` 'shipping' | 'billing': The type of address.
      - `company` string: The company name (if applicable).
      - `street_2` string: Any additional address details (if applicable).
      - `platform_id` string: A platform-generated identifier for the address.
      - `shop_identifier` string: The unique identifier for the store. Retrieve this information by calling the [Get Shop Info](shops#tag/Shop/operation/GetShopInfo) endpoint.
      - `platform_type` string: The ecommerce platform associated with the store.
      - `first_name` string: The customer's first name.
      - `address_source` 'platform' | 'bold': The location the address was created.
      - `last_name` string: The customer's last name.
      - `updated_at` string, date-time: The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) the address was updated. If this value was not updated, it is set to the same value as `created_at`.
      - `phone` string: The customer's phone number.
      - `is_default` boolean: Indicates whether the address is set as the customer's default.
      - `bold_customer_id` integer: The unique, Bold-generated identifier for the customer.
      - `country_iso2` string: The country code, in [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) format.
      - `street_1` string: The street address.
      - `id` integer: The unique, Bold-generated identifier for the address.

## Other responses

- `default`: An unexpected error response

---

[API](https://skmtc.dev/boldcommerce/apis/internal-customers-service.md) - [All operations](https://skmtc.dev/boldcommerce/apis/internal-customers-service/llms.txt) - [OpenAPI document](https://skmtc.dev/boldcommerce/apis/internal-customers-service/revisions/a5bd8a8f3ff6?raw)