> ## Documentation Index > Fetch the complete documentation index at: https://docs.trykintsugi.com/llms.txt > Use this file to discover all available pages before exploring further. # Get Customer By External Id > The Get Customer By External ID API retrieves the details of a single customer using their external identifier. This endpoint is useful for accessing customer data when only an external ID is available. ## OpenAPI ````yaml get /v1/customers/external/{external_id} openapi: 3.0.0 info: title: Tax Platform version: 1.0.0 servers: - url: https://api.trykintsugi.com description: Production API server URL security: [] paths: /v1/customers/external/{external_id}: get: tags: - Customers summary: Get Customer By External Id description: >- The Get Customer By External ID API retrieves the details of a single customer using their external identifier. This endpoint is useful for accessing customer data when only an external ID is available. operationId: get_customer_by_external_id_v1_customers_external__external_id__get parameters: - name: external_id in: path required: true schema: type: string description: The external identifier of the customer to retrieve. title: External Id description: The external identifier of the customer to retrieve. example: external_12345 responses: '200': description: Successfully retrieved customer content: application/json: schema: $ref: '#/components/schemas/CustomerRead' example: phone: 987-654-3210 street_1: 456 Elm St street_2: Suite 202 city: Metropolis county: Wayne state: NY postal_code: '10001' country: US full_address: 456 Elm St, Suite 202, Metropolis, NY 10001 name: Jane Smith external_id: cust_002 status: ACTIVE email: jane.smith@example.com source: SHOPIFY connection_id: conn_12345 address_status: UNVERIFIED id: cust_H5NTxERcncfEN organization_id: orgn_argaLQwMy2fJc '404': description: Resource Not Found content: application/json: example: detail: Customer with id 'cust_01' not found for orgn_argaLQwMy2fJc '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] CustomHeader: [] components: schemas: CustomerRead: properties: phone: description: Customer's phone number type: string street_1: description: Primary street address. type: string street_2: description: >- Additional street address details, such as an apartment or suite number. type: string city: description: City where the customer resides. type: string county: description: County or district of the customer. type: string state: description: State or province of the customer. type: string postal_code: description: ZIP or Postal code of the customer. type: string country: $ref: '#/components/schemas/CountryCodeEnum' description: Country code in ISO 3166-1 alpha-2 format full_address: description: >- Complete address string of the customer, which can be used as an alternative to individual fields. type: string name: description: Name of the customer. type: string external_id: description: External identifier associated with the customer. type: string status: $ref: '#/components/schemas/StatusEnum' description: Status of the customer. default: ACTIVE email: description: Customer's email address type: string source: $ref: '#/components/schemas/SourceEnum' description: Source of the customer's record. connection_id: description: Identifier for the connection source, if applicable. type: string address_status: $ref: '#/components/schemas/AddressStatus' description: Status of address verification default: UNVERIFIED registration_number: description: Registration number of the customer. type: string external_friendly_id: description: >- External friendly identifier associated with the customer. We need it for netsuite. type: string customer_tax_registrations: items: $ref: '#/components/schemas/CustomerTaxRegistrationRead' type: array title: Customer Tax Registrations description: Customer tax registrations associated with the customer. id: type: string title: Id description: Unique identifier for the customer required. organization_id: type: string title: Organization Id description: >- Unique identifier for the organization associated with the customer. Required. type: object required: - id - organization_id title: CustomerRead HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError CountryCodeEnum: type: string enum: - AF - AX - AL - DZ - AS - AD - AO - AI - AQ - AG - AR - AM - AW - AU - AT - AZ - BS - BH - BD - BB - BY - BE - BZ - BJ - BM - BT - BO - BQ - BA - BW - BV - BR - IO - BN - BG - BF - BI - CV - KH - CM - CA - KY - CF - TD - CL - CN - CX - CC - CO - KM - CG - CD - CK - CR - HR - CU - CW - CY - CZ - DK - DJ - DM - DO - EC - EG - SV - GQ - ER - EE - SZ - ET - FK - FO - FJ - FI - FR - GF - PF - TF - GA - GM - GE - DE - GH - GI - GR - GL - GD - GP - GU - GT - GG - GN - GW - GY - HT - HM - VA - HN - HK - HU - IS - IN - ID - IR - IQ - IE - IM - IL - IT - CI - JM - JP - JE - JO - KZ - KE - KI - KP - KR - KW - KG - LA - LV - LB - LS - LR - LY - LI - LT - LU - MO - MG - MW - MY - MV - ML - MT - MH - MQ - MR - MU - YT - MX - FM - MD - MC - MN - ME - MS - MA - MZ - MM - NA - NR - NP - NL - NC - NZ - NI - NE - NG - NU - NF - MK - MP - 'NO' - OM - PK - PW - PS - PA - PG - PY - PE - PH - PN - PL - PT - PR - QA - RE - RO - RU - RW - BL - SH - KN - LC - MF - PM - VC - WS - SM - ST - SA - SN - RS - SC - SL - SG - SX - SK - SI - SB - SO - ZA - GS - SS - ES - LK - SD - SR - SJ - SE - CH - SY - TW - TJ - TZ - TH - TL - TG - TK - TO - TT - TN - TR - TM - TC - TV - UG - UA - AE - GB - US - UM - UY - UZ - VU - VE - VN - VG - VI - WF - EH - YE - ZM - ZW - XK - ZZ_EU title: CountryCodeEnum StatusEnum: type: string enum: - ACTIVE - ARCHIVED title: StatusEnum SourceEnum: type: string enum: - BIGCOMMERCE - BESTBUY - BUNNY - CHARGEBEE - SHOPIFY - STRIPE - AMAZON - TIKTOK - CUSTOM - UNKNOWN - IMPORT - ZUORA - APIDECK - QUICKBOOKS - API - APPLE_APP_STORE - GOOGLE_APP_STORE - WALMART - PAYPAL - NETSUITE - XERO - MAXIO - RECURLY - SALESFORCE - ETSY - EBAY - WIX - SQUARESPACE - WOOCOMMERCE - MAGENTO - BILLING_PLATFORM - DEEL - RIPPLING - GUSTO - FACEBOOK - OTHER - ORDWAY - INSTAGRAM - PINTEREST - WAYFAIR - WISH - POS - TARGET - NEWEGG - GROUPON - GOOGLE_EXPRESS - NOCNOC - MERCADO_LIBRE - MODALYST - NORDSTROM - FAIRE - SHOPWARE - ZOHO - SAGE-INTACCT - AIRWALLEX - ORB - ZENSKAR - MICROSOFT_DYNAMICS_365 - KICKSTARTER - INTERNAL_ERP title: SourceEnum AddressStatus: type: string enum: - UNVERIFIED - INVALID - PARTIALLY_VERIFIED - VERIFIED - UNVERIFIABLE - BLANK title: AddressStatus CustomerTaxRegistrationRead: properties: id: type: string title: Id customer_id: type: string title: Customer Id country_code: $ref: '#/components/schemas/CountryCodeEnum' tax_type: $ref: '#/components/schemas/CustomerTaxTypeEnum' tax_id: type: string title: Tax Id is_valid: type: boolean title: Is Valid type: object required: - id - customer_id - country_code - tax_type - tax_id - is_valid title: CustomerTaxRegistrationRead ValidationError: properties: loc: items: type: string type: array title: Location msg: type: string title: Message type: type: string title: Error Type type: object required: - loc - msg - type title: ValidationError CustomerTaxTypeEnum: type: string enum: - gst - hst - gst_hst - qst - pst - rst - vat - unknown title: CustomerTaxTypeEnum description: Enum for customer tax registration types. securitySchemes: APIKeyHeader: type: apiKey in: header name: X-API-KEY CustomHeader: type: apiKey in: header name: x-organization-id ````