---
updatedAt: 2026-04-23T13:29:19.000Z
agentTools:
  projectIndex: https://developer.xentral.com/llms.txt
---

# View address

Returns details of a single customer address

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Xentral API",
    "version": "v0.1",
    "description": "Xentral is an ERP platform.",
    "contact": {
      "name": "Xentral",
      "url": "https://xentral.com",
      "email": "api@xentral.com"
    }
  },
  "tags": [
    {
      "name": "Customer Address",
      "description": "Represents the address associated with a specific customer, including details such as location, contact information, and address type."
    }
  ],
  "components": {
    "securitySchemes": {
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "description": "Bearer token obtained in POST /tokens endpoint or pregenerated in the system."
      }
    }
  },
  "security": [
    {
      "BearerAuth": []
    }
  ],
  "servers": [
    {
      "url": "https://{xentralId}.xentral.biz",
      "description": "Your Xentral Instance",
      "variables": {
        "xentralId": {
          "default": "xentral"
        }
      }
    },
    {
      "url": "https://{domain}",
      "description": "Xentral at a custom domain",
      "variables": {
        "domain": {
          "default": "xentral.com"
        }
      }
    }
  ],
  "x-readme": {
    "samples-languages": []
  },
  "paths": {
    "/api/v2/customers/{customerId}/addresses/{id}": {
      "get": {
        "tags": [
          "Customer Address"
        ],
        "operationId": "customer.address.view.v2",
        "summary": "View address",
        "description": "Returns details of a single customer address",
        "parameters": [
          {
            "in": "path",
            "name": "customerId",
            "required": true,
            "description": "The customer's identifier.",
            "schema": {
              "type": "string",
              "pattern": "\\d+",
              "example": "17",
              "description": "Resource identifier."
            }
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "description": "The address identifier. Can be `masterdata`, `billingaddress`, or a numeric ID (which corresponds to a delivery address).",
            "schema": {
              "oneOf": [
                {
                  "type": "string",
                  "enum": [
                    "masterdata",
                    "billingaddress"
                  ]
                },
                {
                  "type": "string",
                  "pattern": "\\d+",
                  "example": "17",
                  "description": "Resource identifier."
                }
              ]
            },
            "example": "masterdata"
          }
        ],
        "responses": {
          "200": {
            "description": "Customer address response object",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "data"
                  ],
                  "properties": {
                    "data": {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "id",
                        "type",
                        "name",
                        "street",
                        "addressSupplement",
                        "zip",
                        "city",
                        "country",
                        "state",
                        "department",
                        "subDepartment",
                        "contactDetails"
                      ],
                      "description": "Customer Address object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "pattern": "\\d+",
                          "example": "17",
                          "description": "Resource identifier."
                        },
                        "type": {
                          "type": "string",
                          "enum": [
                            "masterdata",
                            "billingaddress",
                            "deliveryaddress"
                          ],
                          "example": "masterdata",
                          "description": "Type of customer address"
                        },
                        "name": {
                          "type": "string",
                          "nullable": true,
                          "example": "Firstname Surname",
                          "description": "Full name of the customer"
                        },
                        "street": {
                          "type": "string",
                          "nullable": true,
                          "example": "1234 Main Street",
                          "description": "Street name and house number"
                        },
                        "addressSupplement": {
                          "type": "string",
                          "nullable": true,
                          "example": "6. floor",
                          "description": "Additional address information, such as floor or unit"
                        },
                        "zip": {
                          "type": "string",
                          "nullable": true,
                          "example": "12345",
                          "description": "Postal code for the address"
                        },
                        "city": {
                          "type": "string",
                          "nullable": true,
                          "example": "Sampletown",
                          "description": "City of the address"
                        },
                        "country": {
                          "type": "string",
                          "nullable": true,
                          "example": "DE",
                          "description": "Country code in ISO 3166-1 alpha-2 format"
                        },
                        "state": {
                          "type": "string",
                          "nullable": true,
                          "example": "BY",
                          "description": "State or region code in ISO format, if applicable"
                        },
                        "department": {
                          "type": "string",
                          "nullable": true,
                          "example": "HR department",
                          "description": "Department of customer if necessary and available"
                        },
                        "subDepartment": {
                          "type": "string",
                          "nullable": true,
                          "example": "Sub department",
                          "description": "Sub-Department of customer if necessary and available"
                        },
                        "contactDetails": {
                          "type": "object",
                          "additionalProperties": false,
                          "description": "Contact information of a customer",
                          "properties": {
                            "phone": {
                              "type": "string",
                              "nullable": true,
                              "description": "Phone number of a customer",
                              "example": "+49(30)12093756"
                            },
                            "email": {
                              "type": "string",
                              "nullable": true,
                              "description": "Email address of a customer",
                              "example": "customer@domain.tpl"
                            },
                            "gln": {
                              "type": "string",
                              "nullable": true,
                              "description": "Global Location Number (GLN) of the company",
                              "example": "1234567890123",
                              "pattern": "^[0-9]{13}$"
                            }
                          },
                          "example": {
                            "email": "dev@xentral.com",
                            "phone": "+49(0) 174406668",
                            "gln": "1234567890123"
                          }
                        },
                        "deliveryDetails": {
                          "type": "object",
                          "nullable": true,
                          "additionalProperties": false,
                          "description": "Details about the customer's delivery address",
                          "properties": {
                            "defaultDeliveryAddress": {
                              "type": "boolean",
                              "description": "Indicates whether this is the default delivery address. Only one delivery address can be set as default.",
                              "example": true
                            },
                            "termsOfDelivery": {
                              "type": "string",
                              "nullable": true,
                              "description": "Terms of delivery associated with this address",
                              "example": "Some terms here"
                            },
                            "vatId": {
                              "type": "string",
                              "nullable": true,
                              "description": "VAT ID associated with the delivery address. Can be empty.",
                              "example": "DE123456789"
                            },
                            "taxType": {
                              "type": "string",
                              "nullable": true,
                              "enum": [
                                "domestic",
                                "eu-delivery",
                                "export",
                                "free"
                              ],
                              "description": "Tax type associated with the delivery address. Can be one of: domestic, eu-delivery, export, free.",
                              "example": "domestic"
                            },
                            "internalComment": {
                              "type": "string",
                              "nullable": true,
                              "description": "Internal comment about the delivery address",
                              "example": "Some internal remarks here"
                            },
                            "note": {
                              "type": "string",
                              "nullable": true,
                              "description": "Additional note regarding the delivery address",
                              "example": "Some additional notes here"
                            }
                          },
                          "example": {
                            "defaultDeliveryAddress": true,
                            "termsOfDelivery": "Delivered within 5 business days",
                            "vatId": "DE123456789",
                            "taxType": "domestic",
                            "internalComment": "Handle with care. Preferred delivery time: morning.",
                            "note": "Leave package at the front desk if recipient is unavailable."
                          }
                        }
                      },
                      "example": {
                        "id": "1",
                        "type": "deliveryaddress",
                        "name": "Test delivery address",
                        "street": "1",
                        "zip": "12345",
                        "city": "Munich",
                        "country": "DE",
                        "state": "BY",
                        "addressSupplement": "1",
                        "department": "Department",
                        "subDepartment": "Subdepartment",
                        "contactDetails": {
                          "email": "dev@xentral.com",
                          "phone": "+49(0) 174406668",
                          "gln": "1234567890123"
                        },
                        "deliveryDetails": {
                          "taxType": "export",
                          "defaultDeliveryAddress": false,
                          "termsOfDelivery": " Delivery term",
                          "vatId": "123213212",
                          "internalComment": "my awesome delivery internal comment",
                          "note": "my awesome delivery notice"
                        }
                      }
                    },
                    "links": {
                      "type": "object",
                      "description": "A collection of related links for the customer resource.",
                      "properties": {
                        "self": {
                          "type": "string",
                          "description": "A URL linking directly to this specific customer address resource.",
                          "example": "http://localhost/api/v2/customers/2/addresses/1"
                        },
                        "customer": {
                          "type": "string",
                          "description": "A URL linking to the customer resource associated with this address.",
                          "example": "http://localhost/api/v2/customers/2"
                        }
                      },
                      "example": {
                        "links": {
                          "self": "http://localhost/api/v2/customers/2/addresses/1",
                          "customer": "http://localhost/api/v2/customers/2"
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "IETF RFC 9457 Problem API compliant response",
            "content": {
              "application/problem+json": {
                "schema": {
                  "oneOf": [
                    {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "type",
                        "title",
                        "violations"
                      ],
                      "properties": {
                        "type": {
                          "type": "string",
                          "enum": [
                            "https://api.xentral.biz/problems/request-validation"
                          ]
                        },
                        "title": {
                          "type": "string",
                          "minLength": 1,
                          "example": "Request payload validation failed."
                        },
                        "violations": {
                          "oneOf": [
                            {
                              "type": "array",
                              "items": {
                                "type": "object",
                                "example": {
                                  "username": [
                                    "This value should not be blank."
                                  ],
                                  "email": [
                                    "This value is not a valid email address."
                                  ]
                                }
                              },
                              "description": "This field will be a mirrored request payload with only invalid fields and values replaced by error messages."
                            },
                            {
                              "type": "object",
                              "example": {
                                "_": [
                                  "This value should contain at most `9` elements."
                                ]
                              },
                              "description": "This field will be a mirrored request payload with only invalid fields and values replaced by error messages."
                            }
                          ]
                        }
                      }
                    },
                    {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "type",
                        "title",
                        "messages"
                      ],
                      "properties": {
                        "type": {
                          "type": "string",
                          "enum": [
                            "https://api.xentral.biz/problems/generic-validation"
                          ]
                        },
                        "title": {
                          "type": "string",
                          "minLength": 1
                        },
                        "messages": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          }
                        }
                      }
                    },
                    {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "type",
                        "title",
                        "messages"
                      ],
                      "properties": {
                        "type": {
                          "type": "string",
                          "enum": [
                            "https://api.xentral.biz/problems/conflict"
                          ]
                        },
                        "title": {
                          "type": "string",
                          "minLength": 1
                        },
                        "messages": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          }
                        }
                      }
                    },
                    {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "type",
                        "title",
                        "items"
                      ],
                      "properties": {
                        "type": {
                          "type": "string",
                          "enum": [
                            "https://api.xentral.biz/problems/conflictItems"
                          ]
                        },
                        "title": {
                          "type": "string",
                          "minLength": 1
                        },
                        "items": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "additionalProperties": false,
                            "required": [
                              "id",
                              "title",
                              "messages"
                            ],
                            "properties": {
                              "id": {
                                "type": "integer"
                              },
                              "title": {
                                "type": "string",
                                "minLength": 1
                              },
                              "messages": {
                                "type": "array",
                                "items": {
                                  "type": "string"
                                }
                              }
                            }
                          }
                        }
                      }
                    },
                    {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "type",
                        "title",
                        "scopes"
                      ],
                      "properties": {
                        "type": {
                          "type": "string",
                          "enum": [
                            "https://developer.xentral.com/reference/problems#token-scopes"
                          ]
                        },
                        "title": {
                          "type": "string",
                          "minLength": 1
                        },
                        "scopes": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          }
                        }
                      }
                    },
                    {
                      "type": "object",
                      "additionalProperties": false,
                      "required": [
                        "type",
                        "title",
                        "messages"
                      ],
                      "properties": {
                        "type": {
                          "type": "string",
                          "enum": [
                            "https://api.xentral.biz/problems/generic-validation"
                          ]
                        },
                        "title": {
                          "type": "string",
                          "minLength": 1
                        },
                        "messages": {
                          "type": "object",
                          "additionalProperties": {
                            "type": "array",
                            "items": {
                              "type": "string"
                            }
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "401": {
            "description": "Unable to authenticate the client",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "Error message explaining why the request failed.",
                      "example": "Missing required scopes: customer:create."
                    }
                  }
                },
                "example": {
                  "message": "Missing required scopes: customer:create."
                }
              },
              "text/html": {
                "schema": {
                  "type": "string",
                  "example": "Unauthorized"
                }
              }
            }
          },
          "403": {
            "description": "Unable to authorize the client"
          },
          "404": {
            "description": "Resource was not found or not enough access privileges"
          },
          "406": {
            "description": "Requested resource representation does not exist."
          },
          "429": {
            "description": "Too many API calls made."
          }
        }
      }
    }
  }
}
```