# List addresses

List addresses defined for the specified account.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Core platform - Accounts",
    "version": "1.0.0",
    "description": "API used to manage accounts domain",
    "contact": {
      "name": "API Support",
      "url": "https://developers.pismo.io/support/"
    },
    "license": {
      "name": "Copyright Pismo"
    }
  },
  "servers": [
    {
      "url": "https://sandbox.pismolabs.io",
      "description": "API server for testing"
    }
  ],
  "tags": [
    {
      "name": "Addresses",
      "description": "Endpoints to manage addresses"
    }
  ],
  "components": {
    "parameters": {
      "AccountIdPath": {
        "name": "accountId",
        "in": "path",
        "description": "Account ID",
        "required": true,
        "schema": {
          "type": "integer",
          "format": "int64",
          "minimum": 1,
          "example": 123
        }
      },
      "AddressActiveFilterQuery": {
        "name": "active",
        "in": "query",
        "description": "Filter results based on whether the address is active or inactive.",
        "required": false,
        "schema": {
          "type": "boolean",
          "example": true,
          "enum": [
            false,
            true
          ]
        }
      }
    },
    "schemas": {
      "AccountID": {
        "type": "integer",
        "format": "int64",
        "description": "Account ID",
        "example": 1001
      },
      "Address": {
        "type": "string",
        "description": "Street, avenue, road, and so on, name.",
        "maxLength": 300,
        "example": "Mulholland Drive"
      },
      "AddressActive": {
        "type": "boolean",
        "description": "Is address active (`true`) or not (`false`). Default is `true`.",
        "example": true
      },
      "AddressID": {
        "type": "integer",
        "format": "int32",
        "description": "Address ID",
        "example": 456
      },
      "AddressItemResponse": {
        "type": "object",
        "description": "Address response",
        "properties": {
          "id": {
            "$ref": "#/components/schemas/AddressID"
          },
          "address_type": {
            "$ref": "#/components/schemas/AddressType"
          },
          "address": {
            "$ref": "#/components/schemas/Address"
          },
          "number": {
            "$ref": "#/components/schemas/AddressNumber"
          },
          "extended_number": {
            "$ref": "#/components/schemas/AddressExtendedNumber"
          },
          "complementary_address": {
            "$ref": "#/components/schemas/ComplementaryAddress"
          },
          "neighborhood": {
            "$ref": "#/components/schemas/Neighborhood"
          },
          "zip_code": {
            "$ref": "#/components/schemas/ZipCode"
          },
          "city": {
            "$ref": "#/components/schemas/City"
          },
          "state": {
            "$ref": "#/components/schemas/State"
          },
          "country": {
            "$ref": "#/components/schemas/Country"
          },
          "creation_date": {
            "$ref": "#/components/schemas/CustomerAddressDate"
          },
          "mailing_address": {
            "$ref": "#/components/schemas/MailingAddress"
          },
          "active": {
            "$ref": "#/components/schemas/AddressActive"
          },
          "org_id": {
            "$ref": "#/components/schemas/OrganizationID"
          },
          "account_id": {
            "$ref": "#/components/schemas/AccountID"
          },
          "last_update": {
            "$ref": "#/components/schemas/AddressLastUpdate"
          },
          "custom_fields": {
            "$ref": "#/components/schemas/CustomFields"
          }
        }
      },
      "AddressLastUpdate": {
        "type": "string",
        "format": "date-time",
        "example": "2019-07-22T14:35:00.000Z",
        "description": "UTC date/time when address was last updated. Format = yyyy-mm-dd:hr:mm:ss."
      },
      "AddressNumber": {
        "type": "integer",
        "format": "int32",
        "description": "Address number with numeric characters only",
        "example": 456
      },
      "AddressExtendedNumber": {
        "type": "string",
        "description": "Address number with numeric and non-numeric characters",
        "example": "456 B"
      },
      "AddressType": {
        "type": "string",
        "description": "Address type",
        "enum": [
          "RESIDENTIAL",
          "COMMERCIAL",
          "OTHER"
        ],
        "example": "RESIDENTIAL"
      },
      "City": {
        "type": "string",
        "description": "Address city",
        "maxLength": 100,
        "example": "San Diego"
      },
      "ComplementaryAddress": {
        "type": "string",
        "description": "Any additional information such as suite, apt., and so on.",
        "maxLength": 100,
        "example": "Apt 1408"
      },
      "Country": {
        "type": "string",
        "description": "Address country",
        "maxLength": 30,
        "example": "Brazil"
      },
      "CustomerAddressDate": {
        "type": "string",
        "description": "Date customer first acquired this address. Format = dd/mm/yyyy.",
        "example": "15/05/2022"
      },
      "CustomFields": {
        "type": "object",
        "description": "Key/value field for custom information. (Limited to 1014 bytes.)",
        "example": {
          "field_01": "value01",
          "field_02": "value02"
        }
      },
      "MailingAddress": {
        "type": "boolean",
        "description": "Is this address the mailing address?\n\nOnly one address can have this field set to `true`.\n",
        "example": true
      },
      "Neighborhood": {
        "type": "string",
        "description": "Address neighborhood. Some countries use neighborhood in addresses.",
        "maxLength": 100,
        "example": "Shady Pines"
      },
      "OrganizationID": {
        "type": "string",
        "description": "Organization ID",
        "example": "TN-34778262-f4f0-464d-b4c6-a14e2dc6f4be"
      },
      "SimpleError": {
        "title": "SimpleError",
        "type": "object",
        "required": [
          "message"
        ],
        "properties": {
          "message": {
            "type": "string",
            "description": "Error message"
          }
        }
      },
      "State": {
        "type": "string",
        "description": "Address state",
        "maxLength": 30,
        "example": "California"
      },
      "ZipCode": {
        "type": "string",
        "maxLength": 16,
        "description": "Zip/postal code",
        "example": "12345-678"
      }
    },
    "securitySchemes": {
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    }
  },
  "security": [
    {
      "BearerAuth": []
    }
  ],
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true,
    "samples-enabled": true
  },
  "paths": {
    "/accounts/v1/accounts/{accountId}/addresses": {
      "get": {
        "operationId": "get-accounts-v1-accounts-accountId-addresses",
        "summary": "List addresses",
        "description": "List addresses defined for the specified account.",
        "tags": [
          "Addresses"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/AccountIdPath"
          },
          {
            "$ref": "#/components/parameters/AddressActiveFilterQuery"
          }
        ],
        "responses": {
          "200": {
            "description": "Ok",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/AddressItemResponse"
                  }
                },
                "examples": {
                  "Address list": {
                    "value": [
                      {
                        "zip_code": "18047620",
                        "country": "BRA",
                        "address": "Avenida Antônio Carlos Comitre",
                        "city": "Sorocaba",
                        "address_type": "COMMERCIAL",
                        "active": true,
                        "creation_date": "2023-04-06T20:24:49Z",
                        "org_id": "TN-02b1acbb-9fe3-45e4-8b20-f3afaf0b2970",
                        "number": 1393,
                        "account_id": 115203987,
                        "complementary_address": "null",
                        "mailing_address": true,
                        "last_update": "2019-07-22T14:35:00.000Z",
                        "customer_ids": "null",
                        "id": 32670165,
                        "neighborhood": "Faraway Creek",
                        "state": "SP"
                      }
                    ]
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SimpleError"
                },
                "examples": {
                  "Internal server error": {
                    "value": {
                      "message": "Not possible to find all addresses"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}
```