> ## Documentation Index
> Fetch the complete documentation index at: https://developer.vetcove.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List all addresses

> Returns a list of all addresses for clinic clients (pet parents). The addresses are sorted by creation date, with the most recent addresses appearing first. When using modified filters, results are sorted in descending modification date instead.

An address represents a physical mailing or shipping location associated with a client. Addresses are used as shipping destinations for product orders and may be designated as the client's primary address.



## OpenAPI

````yaml get /ext/v2/addresses/
openapi: 3.1.0
info:
  description: ''
  title: NinjaAPI
  version: 2.0.0
servers:
  - url: https://connect.vetcove.com/
security: []
paths:
  /ext/v2/addresses/:
    get:
      tags:
        - Accounts
      summary: List all addresses
      description: >-
        Returns a list of all addresses for clinic clients (pet parents). The
        addresses are sorted by creation date, with the most recent addresses
        appearing first. When using modified filters, results are sorted in
        descending modification date instead.


        An address represents a physical mailing or shipping location associated
        with a client. Addresses are used as shipping destinations for product
        orders and may be designated as the client's primary address.
      operationId: addresses_list
      parameters:
        - description: When provided, filters to objects with these IDs.
          in: query
          name: ids
          required: false
          schema:
            anyOf:
              - items:
                  type: integer
                type: array
              - type: 'null'
            description: When provided, filters to objects with these IDs.
            title: Ids
        - description: >-
            A cursor used for pagination. Fetches the page of results ending
            immediately before the object with the given ID. Cannot be used at
            the same time as `starting_after`.
          in: query
          name: ending_before
          required: false
          schema:
            anyOf:
              - type: integer
              - type: 'null'
            description: >-
              A cursor used for pagination. Fetches the page of results ending
              immediately before the object with the given ID. Cannot be used at
              the same time as `starting_after`.
            title: Ending Before
        - description: >-
            A cursor used for pagination. Fetches the page of results starting
            immediately after the given ID. Cannot be used at the same time as
            `ending_before`.
          in: query
          name: starting_after
          required: false
          schema:
            anyOf:
              - type: integer
              - type: 'null'
            description: >-
              A cursor used for pagination. Fetches the page of results starting
              immediately after the given ID. Cannot be used at the same time as
              `ending_before`.
            title: Starting After
        - description: The maximum number of items to return per page.
          in: query
          name: limit
          required: false
          schema:
            default: 10
            description: The maximum number of items to return per page.
            maximum: 100
            minimum: 1
            title: Limit
            type: integer
        - description: >-
            A cursor token used for pagination. This token contains encoded
            information about the last seen record in order to continue
            pagination. Cannot be used with `starting_after` or `ending_before`
            parameters.
          in: query
          name: cursor
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              A cursor token used for pagination. This token contains encoded
              information about the last seen record in order to continue
              pagination. Cannot be used with `starting_after` or
              `ending_before` parameters.
            title: Cursor
        - description: >-
            Filters to objects modified on or after this datetime (ISO8601 UTC,
            e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or
            `ending_before` parameters.
          in: query
          name: modified__gte
          required: false
          schema:
            anyOf:
              - format: date-time
                type: string
              - type: 'null'
            description: >-
              Filters to objects modified on or after this datetime (ISO8601
              UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with
              `starting_after` or `ending_before` parameters.
            title: Modified  Gte
        - description: >-
            Filters to objects modified on or before this datetime (ISO8601 UTC,
            e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or
            `ending_before` parameters.
          in: query
          name: modified__lte
          required: false
          schema:
            anyOf:
              - format: date-time
                type: string
              - type: 'null'
            description: >-
              Filters to objects modified on or before this datetime (ISO8601
              UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with
              `starting_after` or `ending_before` parameters.
            title: Modified  Lte
        - description: >-
            When 'FALSE' (default), filters to non-deleted records only. When
            'TRUE', filters to soft-deleted records only. When 'ALL', returns
            both deleted and non-deleted records.
          in: query
          name: is_deleted
          required: false
          schema:
            allOf:
              - enum:
                  - 'FALSE'
                  - 'TRUE'
                  - ALL
                title: DeletedFilterOption
                type: string
            default: 'FALSE'
            description: >-
              When 'FALSE' (default), filters to non-deleted records only. When
              'TRUE', filters to soft-deleted records only. When 'ALL', returns
              both deleted and non-deleted records.
        - description: When provided, filters to addresses for the clinic with this ID.
          in: query
          name: clinic_id
          required: false
          schema:
            anyOf:
              - type: integer
              - type: 'null'
            description: When provided, filters to addresses for the clinic with this ID.
            title: Clinic Id
        - description: Filters to addresses for the clinic client with this ID.
          in: query
          name: clinic_client_id
          required: false
          schema:
            anyOf:
              - type: integer
              - type: 'null'
            description: Filters to addresses for the clinic client with this ID.
            title: Clinic Client Id
        - description: >-
            Filter by active status. Defaults to true (only active addresses).
            Set to false to include only deactivated addresses, or omit to
            return all regardless of active status.
          in: query
          name: is_active
          required: false
          schema:
            anyOf:
              - type: boolean
              - type: 'null'
            default: true
            description: >-
              Filter by active status. Defaults to true (only active addresses).
              Set to false to include only deactivated addresses, or omit to
              return all regardless of active status.
            title: Is Active
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalClientAddressSchemaList'
          description: OK
      security:
        - ExternalAPIAuth: []
components:
  schemas:
    ExternalClientAddressSchemaList:
      properties:
        data:
          description: A single page of data contained within this list.
          items:
            $ref: '#/components/schemas/ExternalClientAddressSchema'
          title: Data
          type: array
        has_more:
          default: false
          description: Whether there are more pages or data in this list.
          title: Has More
          type: boolean
        next_page:
          description: A URL linking to the next page of this list.
          title: Next Page
          type: string
        type:
          default: list
          description: Type of this object. Always `list`.
          title: Type
          type: string
      required:
        - data
        - next_page
      title: ExternalClientAddressSchemaList
      type: object
    ExternalClientAddressSchema:
      properties:
        address_one:
          description: The first line of the address.
          maxLength: 100
          title: Address One
          type: string
        address_two:
          default: ''
          description: The second line of the address.
          maxLength: 100
          title: Address Two
          type: string
        city:
          description: The city of the address.
          maxLength: 100
          title: City
          type: string
        client_id:
          description: The ID of the client that this address belongs to.
          title: Client Id
          type: integer
        clinic_id:
          anyOf:
            - type: integer
            - type: 'null'
          description: The ID of the clinic this address belongs to.
          title: Clinic Id
        country:
          allOf:
            - $ref: '#/components/schemas/Countries'
          default: US
          description: The 2-letter code of the country of the address.
        county:
          default: ''
          description: The county of the address.
          maxLength: 100
          title: County
          type: string
        created:
          description: The datetime this object was created.
          format: date-time
          title: Created
          type: string
        deleted:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          description: The datetime this record was soft deleted.
          title: Deleted
        id:
          description: The ID of the address.
          title: Id
          type: integer
        is_deleted:
          description: Whether this record is soft deleted or not.
          title: Is Deleted
          type: boolean
        is_primary:
          description: Whether this address is the primary address of the client.
          title: Is Primary
          type: boolean
        modified:
          description: >-
            The datetime this object was last modified; changes to related
            entities will not update this field.
          format: date-time
          title: Modified
          type: string
        name:
          default: ''
          description: The name of the address.
          maxLength: 100
          title: Name
          type: string
        phone_number:
          anyOf:
            - type: integer
            - type: 'null'
          description: The phone number of the address.
          title: Phone Number
        state:
          description: >-
            The 2-letter code of the state/province/region of the address.
            Legacy data could deviate from the 2-letter code convention.
          title: State
          type: string
        zipcode:
          description: The zip code/postal code of the address.
          maxLength: 10
          title: Zipcode
          type: string
      required:
        - address_one
        - city
        - state
        - zipcode
        - id
        - created
        - modified
        - is_deleted
        - deleted
        - client_id
        - clinic_id
        - is_primary
      title: ExternalClientAddressSchema
      type: object
    Countries:
      enum:
        - CA
        - US
        - AS
        - GU
        - MP
        - PR
        - VI
      title: Countries
      type: string
  securitySchemes:
    ExternalAPIAuth:
      scheme: bearer
      type: http

````