---
title: "GET /api/customers/{id}"
method: GET
path: "/api/customers/{id}"
tags: ["api", "customers"]
---

# GET /api/customers/{id}

`GET /api/customers/{id}`

Get Customer

## Path parameters

- `id` string, required — The ID of the customer

## Response `200`

OK

- CustomerResource — The associated customer which has been updated
  - `_id` string, required — The ID of the customer
  - `company` string, nullable — The company of the customer
  - `name` string, nullable — The name of the customer collected from first name and last name
  - `prename` string, nullable — The first name of the customer
  - `lastname` string, nullable — The lastname of the customer
  - `image` string, nullable — The image of the customer
  - `primaryEmail` string, email, required — The primary email of the customer
  - `number` number, float — The number of the customer. Need to be unique and incrementing
  - `phone` string — The phone number of the customer
  - `location` object — The location of the customer
    - `street` string, nullable — The street of the location
    - `line2` string, nullable — The additional address fields of the location
    - `postal` string, nullable — The postal of the location
    - `city` string, nullable — The city of the location
    - `locale` string, nullable — The locale of the location
    - `state` string, nullable — The state of the location
    - `center` number[], nullable — The center of the location
    - `country` string, nullable — An ISO-3166-1 Alpha 2 country code of the location
  - `sellerId` string — The ID of the seller of the customer
  - `notes` string, nullable — Notes of the customer
  - `extraFields` object, nullable — Extra fields of the customer
  - `tags` string[] — An array of tags
  - `segments` string[] — An array of segment slugs, read only
  - `blocked` boolean — Whether the customer is blocked
  - `verified` boolean — Whether the customer is verified
  - `identification` LegalIdentificationDocumentResource[] — An array of identification items
    - union
      - object
        - `type` 'france_siren', required
        - `identifier` string, required
      - object
        - `type` 'spain_tax_id' | 'origin_country_id', required — The type of the identification document.
  - `_account` object — Account specific information about the customer
    - `verificationToken` string — The verification token will be sent to the customer via email within a verification link, which can be used to verify the account of the customer
    - `passwordResetToken` string — The password reset token will be sent within a password reset link via email, which can be used by the customer to reset its password
    - `limitations` object — Account specific limitations of the customer
      - `nextVerificationMailRequest` string, date-time — An ISO timestamp indicating when the next verification mail request can be sent
    - `loginType` 'password' | 'identityprovider', nullable — The login type of the customer.
  - `meta` object — Custom key-value data. Metadata is useful for storing additional, structured information on an object.
  - `externalId` string, nullable — An external identifier of the customer
  - `createdAt` string, date-time — An ISO timestamp indicating when the customer was created
  - `updatedAt` string, date-time — An ISO timestamp indicating when the customer was updated

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `404` — Not Found

---

[API](https://skmtc.net/vivenu/apis/vivenu-api.md) · [All operations](https://skmtc.net/vivenu/apis/vivenu-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vivenu/vivenu-api/revisions/36be0dca14e7/schema)