--- updatedAt: 2026-04-23T13:29:19.000Z agentTools: projectIndex: https://developer.xentral.com/llms.txt --- # List addresses Fetches a list of addresses that belong to specified customer. The list includes the main address (type=masterdata), billing address (type=billingaddress) and all delivery addresses (type=deliveryaddress). # 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": { "get": { "tags": [ "Customer Address" ], "operationId": "customer.address.list.v2", "summary": "List addresses", "description": "Fetches a list of addresses that belong to specified customer. The list includes the main address (type=masterdata), billing address (type=billingaddress) and all delivery addresses (type=deliveryaddress).", "parameters": [ { "in": "path", "name": "customerId", "required": true, "description": "The customer's identifier.", "schema": { "type": "string", "pattern": "\\d+", "example": "17", "description": "Resource identifier." } }, { "name": "filter", "in": "query", "style": "deepObject", "schema": { "anyOf": [ { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "key": { "type": "string", "enum": [ "type" ] }, "op": { "type": "string", "enum": [ "equals", "notEquals", "in", "notIn" ] }, "value": { "oneOf": [ { "type": "string", "enum": [ "masterdata", "billingaddress", "deliveryaddress" ] } ] } } } } ] } }, { "name": "page", "in": "query", "style": "deepObject", "schema": { "oneOf": [ { "type": "object", "additionalProperties": false, "required": [ "number", "size" ], "properties": { "number": { "type": "string", "pattern": "\\d+", "description": "Page number should be an integer greater than or equal to 1" }, "size": { "type": "string", "pattern": "\\d+", "description": "Page size should usually be an integer between 10 and 50." } } } ] }, "description": "Use either page-based or cursor-based pagination, but not both." } ], "responses": { "200": { "description": "List of customer's addresses", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "data", "extra", "links" ], "properties": { "data": { "type": "array", "minItems": 0, "items": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "pattern": "^(masterdata|billingaddress|\\d+)$", "example": "masterdata", "description": "Resource identifier. Can be 'masterdata', 'billingaddress', or a numeric id." }, "type": { "type": "string", "enum": [ "masterdata", "billingaddress", "deliveryaddress" ], "example": "masterdata", "description": "The type of the address. Can be 'masterdata', 'billingaddress', or 'deliveryaddress'." }, "name": { "type": "string", "example": "John Doe", "description": "The recipient's name." }, "street": { "type": "string", "example": "1234 street", "description": "Street and house number." }, "addressSupplement": { "type": "string", "nullable": true, "example": "5th floor", "description": "Optional second address line." }, "department": { "type": "string", "nullable": true, "example": "Financial & Accounting", "description": "Department." }, "subDepartment": { "type": "string", "nullable": true, "example": "Purchase accounting", "description": "Sub-department." }, "zip": { "type": "string", "example": "12345", "description": "Postal code." }, "city": { "type": "string", "example": "Sampletown", "description": "City." }, "country": { "type": "string", "example": "DE", "description": "Country code in ISO 3166-1 alpha-2 format." }, "state": { "type": "string", "example": "BY", "description": "State code in ISO 3166-2 format." } } } }, "extra": { "type": "object", "required": [ "totalCount", "page" ], "additionalProperties": false, "x-description-ignore": true, "properties": { "totalCount": { "description": "the total count of all items", "type": "integer", "example": 1 }, "page": { "description": "The pagination object containing the current page number and size", "type": "object", "required": [ "number", "size" ], "additionalProperties": false, "properties": { "number": { "description": "The current page number", "type": "integer", "example": 1 }, "size": { "description": "The size of the pages", "type": "integer", "example": 10 } }, "example": { "number": 1, "size": 10 } } }, "example": { "totalCount": 1, "page": { "number": 1, "size": 10 } } }, "links": { "type": "object", "additionalProperties": false, "description": "Paths for list traversal and to access related resources.", "properties": { "self": { "type": "string", "nullable": false, "description": "The URI of the current page.", "example": "/api/v2/customers/1234/addresses?page%5Bnumber%5D=2&page%5Bsize%5D=10" }, "next": { "type": "string", "nullable": true, "description": "The path of the next page. If value is null, this is the last page.", "example": "/api/v2/customers/1234/addresses?page%5Bnumber%5D=3&page%5Bsize%5D=10" }, "prev": { "type": "string", "nullable": true, "description": "The path of the previous page. If value is null, this is the first page.", "example": "/api/v2/customers/1234/addresses?page%5Bnumber%5D=1&page%5Bsize%5D=10" }, "customer": { "type": "string", "nullable": false, "description": "The path of the customer resource.", "example": "/api/v2/customers/1234" } }, "example": { "self": "/api/v2/customers/1234/addresses?page%5Bnumber%5D=2&page%5Bsize%5D=10", "next": "/api/v2/customers/1234/addresses?page%5Bnumber%5D=3&page%5Bsize%5D=10", "prev": "/api/v2/customers/1234/addresses?page%5Bnumber%5D=1&page%5Bsize%5D=10", "customer": "/api/v2/customers/1234" } } } } } } }, "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." } } } } } } ```