---
title: "Get Customer Details"
method: GET
path: "/customers/{customerId}"
---

# Get Customer Details

`GET /customers/{customerId}`

Retrieves the details of a customer from a specific source. Use `embed` to other parameters to fetch specific details required.

## Path parameters

- `customerId` integer, required

## Query parameters

- `source` 'INSTORE' | 'MARTJACK' | 'WECHAT' | 'LINE' | 'ALL', required
- `accountId` string
- `embed` string[]
- `includedAllUserGroup2` boolean
- `userGroup2Id` integer
- `includedUserGroup2LoyaltyDetails` boolean
- `includedFraudDetails` boolean
- `includedOnlyCurrentProfile` boolean
- `ug2JoinedStartDate` string, date
- `ug2JoinedEndDate` string, date
- `ug2Offset` integer
- `ug2Limit` integer
- `ug2SortBy` string
- `ug2SortOrder` 'ASC' | 'DESC'
- `ug2PaginationDetails` boolean

## Headers

- `X-CAP-API-OAUTH-TOKEN` string, required
- `language` string

## Response `200`

200

- union
  - object
    - `id` integer
    - `profiles` object[]
      - `firstName` string
      - `lastName` string
      - `attribution` object
        - `createDate` string
        - `createdBy` object
          - `code` string
          - `description` string
          - `name` string
          - `type` string
        - `modifiedBy` object
          - `code` string
          - `description` string
          - `name` string
          - `type` string
        - `modifiedDate` string
      - `fields` object
        - `Gender` string
        - `Favorite Color` string
      - `identifiers` object[]
        - `type` string
        - `value` string
      - `commChannels` object[]
        - `type` string
        - `value` string
        - `primary` boolean
        - `verified` boolean
        - `meta` object
          - `residence` boolean
          - `office` boolean
      - `source` string
      - `userId` integer
      - `accountId` string
      - `conflictingProfileList` unknown[]
        - unknown
      - `autoUpdateTime` string
      - `identifiersAll` object[]
        - `type` string
        - `value` string
    - `loyaltyInfo` object
      - `loyaltyType` string
      - `attributionV2` object
        - `createDate` string
        - `createdBy` object
          - `code` string
          - `name` string
        - `modifiedBy` object
          - `code` string
          - `name` string
        - `modifiedDate` string
      - `lifetimePurchases` integer
    - `segments` object
    - `extendedFields` object
      - `city` string
      - `gender` string
    - `cardDetails` object[]
      - `cardId` integer
      - `issuedDate` string
      - `createdDate` string
      - `expiryDays` integer
      - `seriesName` string
      - `customerId` integer
      - `maxActiveCards` integer
      - `cardExternalId` string
      - `extendedFields` object
        - `advance_card_personalisation` string
        - `card_balance` integer
        - `year_of_registration` integer
      - `customFields` object
        - `cardname` string
        - `cardscope` string
        - `cardtype` string
      - `type` string
      - `cardNumber` string
      - `seriesId` integer
      - `seriesCode` string
      - `orgId` integer
      - `entityId` integer
      - `statusInfo` object
        - `reason` string
        - `createdBy` integer
        - `actions` unknown[]
          - unknown
        - `autoUpdateTime` string
        - `createdOn` string
        - `entityId` integer
        - `id` integer
        - `isActive` boolean
        - `labelId` integer
        - `label` string
        - `status` string
      - `id` integer
      - `transactionNotAllowed` boolean
    - `warnings` unknown[]
      - unknown
  - object
    - `id` integer
    - `profiles` object[]
      - `firstName` string
      - `lastName` string
      - `attribution` object
        - `createDate` string
        - `createdBy` object
          - `id` integer
          - `code` string
          - `name` string
          - `type` string
        - `modifiedBy` object
          - `id` integer
          - `code` string
          - `name` string
          - `type` string
        - `modifiedDate` string
      - `fields` object
      - `identifiers` object[]
        - `type` string
        - `value` string
      - `commChannels` object[]
        - `type` string
        - `value` string
        - `primary` boolean
        - `verified` boolean
        - `meta` object
          - `residence` boolean
          - `office` boolean
        - `attributes` object
      - `source` string
      - `userId` integer
      - `accountId` string
      - `conflictingProfileList` unknown[]
        - unknown
      - `autoUpdateTime` string
      - `identifiersAll` object[]
        - `type` string
        - `value` string
    - `loyaltyInfo` object
      - `loyaltyType` string
      - `attributionV2` object
        - `createDate` string
        - `createdBy` object
          - `id` integer
          - `code` string
          - `name` string
          - `type` string
        - `modifiedBy` object
          - `id` integer
          - `code` string
          - `name` string
          - `type` string
        - `modifiedDate` string
        - `createdFromSource` string
      - `lifetimePurchases` integer
    - `segments` object
    - `associatedWith` string
    - `ug2Pagination` object
      - `ug2Offset` integer
      - `ug2Limit` integer
      - `ug2SortBy` string
      - `ug2SortOrder` string
      - `ug2Total` integer
    - `extendedFields` object
      - `city` string
      - `gender` string
    - `cardDetails` object[]
      - `cardId` integer
      - `issuedDate` string
      - `createdDate` string
      - `expiryDays` integer
      - `seriesName` string
      - `customerId` integer
      - `maxActiveCards` integer
      - `customFields` object
      - `type` string
      - `cardNumber` string
      - `seriesId` integer
      - `seriesCode` string
      - `orgId` integer
      - `entityId` integer
      - `statusInfo` object
        - `reason` string
        - `createdBy` integer
        - `actions` unknown[]
          - unknown
        - `autoUpdateTime` string
        - `createdOn` string
        - `entityId` integer
        - `id` integer
        - `isActive` boolean
        - `labelId` integer
        - `label` string
        - `status` string
      - `id` integer
      - `transactionNotAllowed` boolean
      - `expiryDate` string
    - `warnings` unknown[]
      - unknown
  - object
    - `id` integer
    - `profiles` object[]
      - `firstName` string
      - `lastName` string
      - `attribution` object
        - `createDate` string
        - `createdBy` object
          - `id` integer
          - `code` string
          - `name` string
          - `type` string
        - `modifiedBy` object
          - `id` integer
          - `code` string
          - `name` string
          - `type` string
        - `modifiedDate` string
      - `fields` object
        - `age_group` string
        - `anniversary` string
        - `dateofbirth` string
        - `gender` string
        - `kid_birthday` string
        - `kid_name` string
        - `tnc` string
      - `identifiers` object[]
        - `type` string
        - `value` string
      - `commChannels` object[]
        - `type` string
        - `value` string
        - `primary` boolean
        - `verified` boolean
        - `meta` object
          - `residence` boolean
          - `office` boolean
        - `attributes` object
      - `source` string
      - `userId` integer
      - `accountId` string
      - `conflictingProfileList` unknown[]
        - unknown
      - `autoUpdateTime` string
      - `identifiersAll` object[]
        - `type` string
        - `value` string
    - `loyaltyInfo` object
      - `loyaltyType` string
      - `attributionV2` object
        - `createDate` string
        - `createdBy` object
          - `id` integer
          - `code` string
          - `name` string
          - `type` string
        - `modifiedBy` object
          - `id` integer
          - `code` string
          - `name` string
          - `type` string
        - `modifiedDate` string
        - `createdFromSource` string
      - `lifetimePurchases` integer
    - `fraudDetails` object
      - `markedBy` object
        - `code` string
        - `name` string
      - `modifiedOn` string
      - `status` string
    - `segments` object
    - `associatedWith` string
    - `statusLabel` string
    - `statusLabelReason` string
    - `statusLastUpdatedOn` string
    - `statusModifiedBy` integer
    - `extendedFields` object
      - `city` string
      - `gender` string
      - `newsletter_email` string
      - `newsletter_mobile_push` string
      - `newsletter_sms` string
      - `state` string
    - `cardDetails` object[]
      - `cardId` integer
      - `issuedDate` string
      - `createdDate` string
      - `expiryDays` integer
      - `seriesName` string
      - `customerId` integer
      - `maxActiveCards` integer
      - `customFields` object
      - `type` string
      - `cardNumber` string
      - `seriesId` integer
      - `seriesCode` string
      - `orgId` integer
      - `entityId` integer
      - `statusInfo` object
        - `reason` string
        - `createdBy` integer
        - `actions` unknown[]
          - unknown
        - `autoUpdateTime` string
        - `createdOn` string
        - `entityId` integer
        - `id` integer
        - `isActive` boolean
        - `labelId` integer
        - `label` string
        - `status` string
      - `id` integer
      - `transactionNotAllowed` boolean
      - `activeAndDigital` boolean
      - `expiryDate` string
    - `warnings` unknown[]
      - unknown

## Other responses

- `500` — 500

---

[API](https://skmtc.net/capillarytech/apis/sample-api.md) · [All operations](https://skmtc.net/capillarytech/apis/sample-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/capillarytech/sample-api/versions/de241f2ed9b3/schema)