> ## 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 Physical Nexus

> Retrieve a paginated list of
    physical nexuses for a specific organization.



## OpenAPI

````yaml get /v1/nexus/physical_nexus
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/nexus/physical_nexus:
    get:
      tags:
        - Nexus
      summary: Get Physical Nexus
      description: |-
        Retrieve a paginated list of
            physical nexuses for a specific organization.
      operationId: get_physical_nexus_v1_nexus_physical_nexus_get
      parameters:
        - name: country_code
          in: query
          required: false
          schema:
            type: string
        - name: state_code
          in: query
          required: false
          schema:
            type: string
        - name: order_by
          in: query
          required: false
          schema:
            default: country_code,state_code,start_date,end_date
            type: string
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            description: Page number
            default: 1
            title: Page
          description: Page number
        - name: size
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            description: Page size
            default: 50
            title: Size
          description: Page size
      responses:
        '200':
          description: Successfully retrieved physical nexuses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Page_PhysicalNexusRead_'
              example:
                items:
                  - country_code: US
                    state_code: CA
                    start_date: '2024-01-01'
                    category: PHYSICAL_BUSINESS_LOCATION
                    id: phys_ABC123DEF456
                  - country_code: US
                    state_code: NY
                    start_date: '2024-03-15'
                    category: TELECOMMUTING_OR_REMOTE_EMPLOYEE
                    id: phys_XYZ789GHI012
                  - country_code: US
                    state_code: TX
                    start_date: '2024-06-01'
                    category: PHYSICAL_BUSINESS_LOCATION
                    external_id: ext_98765
                    id: phys_456DEF123ABC
                  - country_code: US
                    state_code: FL
                    start_date: '2024-07-01'
                    end_date: '2024-12-31'
                    category: TELECOMMUTING_OR_REMOTE_EMPLOYEE
                    external_id: ext_54321
                    id: phys_321CBA654FED
                  - country_code: US
                    state_code: WA
                    start_date: '2024-09-01'
                    category: PHYSICAL_BUSINESS_LOCATION
                    id: phys_654FED321CBA
                total: 2
                page: 1
                size: 50
                pages: 1
        '401':
          description: Unauthenticated request.
          content:
            application/json:
              example:
                detail: The request is missing a valid x-api-key.
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              example:
                detail: Entered an incorrect URL.
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation error
          content:
            application/json:
              example:
                detail:
                  - type: missing
                    loc:
                      - header
                      - x-organization-id
                    msg: Field required
              schema:
                $ref: >-
                  #/components/schemas/backend__src__nexus__responses__ValidationErrorResponse
        '500':
          description: Internal server error
          content:
            application/json:
              example:
                detail: An unexpected error occurred
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - APIKeyHeader: []
          CustomHeader: []
components:
  schemas:
    Page_PhysicalNexusRead_:
      properties:
        items:
          items:
            $ref: '#/components/schemas/PhysicalNexusRead'
          type: array
          title: Items
        total:
          type: integer
          minimum: 0
          title: Total
        page:
          type: integer
          minimum: 1
          title: Page
        size:
          type: integer
          minimum: 1
          title: Size
        pages:
          type: integer
          minimum: 0
          title: Pages
      type: object
      required:
        - items
        - total
        - page
        - size
        - pages
      title: Page[PhysicalNexusRead]
    ErrorResponse:
      properties:
        detail:
          type: string
          title: Detail
          description: Error message
      type: object
      required:
        - detail
      title: ErrorResponse
    backend__src__nexus__responses__ValidationErrorResponse:
      properties:
        detail:
          items:
            $ref: >-
              #/components/schemas/backend__src__nexus__responses__ValidationErrorItem
          type: array
          title: Detail
      type: object
      required:
        - detail
      title: ValidationErrorResponse
    PhysicalNexusRead:
      properties:
        country_code:
          $ref: '#/components/schemas/CountryCodeEnum'
          description: |-
            The country code in ISO
                                                    3166-1 alpha-2 format (e.g., US).
        state_code:
          type: string
          title: State Code
          description: |-
            The state or province code in
                                        ISO 3166-2 format (e.g., CA).
        start_date:
          type: string
          format: date
          title: Start Date
          description: |-
            The date when the nexus became
                                        effective (YYYY-MM-DD).
        end_date:
          description: |-
            The date when the
                                                    nexus ended, if applicable.
          type: string
        category:
          $ref: '#/components/schemas/PhysicalNexusCategory'
          description: |-
            The reason for the
                                                        nexus (e.g.,
                                                        'TELECOMMUTING_OR_REMOTE_EMPLOYEE').
        external_id:
          description: |-
            Optional
                                                    external identifier for the nexus.
          type: string
        source:
          $ref: '#/components/schemas/PhysicalNexusSource'
          description: |-
            The source of the physical nexus presence.
                    Possible values: USER, DEEL.
          default: USER
        street_1:
          description: Primary street address for the physical presence location.
          type: string
        street_2:
          description: Additional street address details, such as suite or unit number.
          type: string
        city:
          description: City of the physical presence location.
          type: string
        postal_code:
          description: ZIP or postal code of the physical presence location.
          type: string
        id:
          type: string
          title: Id
          description: The unique identifier for the physical nexus.
      type: object
      required:
        - country_code
        - state_code
        - start_date
        - category
        - id
      title: PhysicalNexusRead
    backend__src__nexus__responses__ValidationErrorItem:
      properties:
        type:
          type: string
          title: Type
          description: |-
            Validation issues, such as missing required
                                fields or invalid field values.
        loc:
          items:
            type: string
          type: array
          title: Loc
          description: Location of error
        msg:
          type: string
          title: Msg
          description: Error message
        input:
          title: Input
          description: Invalid input value
        ctx:
          additionalProperties: true
          type: object
          title: Ctx
          description: Additional context
      type: object
      required:
        - type
        - loc
        - msg
        - input
        - ctx
      title: ValidationErrorItem
    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
    PhysicalNexusCategory:
      type: string
      enum:
        - PHYSICAL_BUSINESS_LOCATION
        - TELECOMMUTING_OR_REMOTE_EMPLOYEE
        - WARRANTY_AND_REPAIR_SERVICES
        - CATALOGUE_DISTRIBUTION_OR_ADVERTISING_MATERIAL
        - DELIVERY_BY_COMMON_CARRIER
        - DELIVERY_BY_OWN_VEHICLES
        - IN_STATE_SALES_PERSON
        - INDEPENDENT_CONTRACTOR_OR_THIRD_PARTY_SALES_PERSON
        - WAREHOUSE_AND_INVENTORY_PRESENCE
        - EMPLOYEES_AGENTS_CONTRACTORS
        - OWN_LEASE_A_PROPERTY
        - INVENTORY
        - DELIVERY_USING_COMPANY_VEHICLES
        - OWN_BUSINESS_INFRASTRUCTURE_AND_EQUIPMENT
        - ON_SITE_INSTALLATION_MAINTENANCE_SERVICES
        - FREQUENT_PARTICIPATION_IN_TRADE_SHOWS_EVENTS
        - MANUFACTURE_OR_PRODUCTION_IN_CANADA
        - PERFORMING_SERVICES_IN_THE_JURISDICTION
        - MANUFACTURING_FACILITIES
        - SERVERS_DATA_CENTERS
        - TRADE_SHOW_PRESENCE
        - TRADE_SHOW_PRESENCE_WITHOUT_SALES
        - DIGITAL_INFRASTRUCTURE_LOCALIZED
        - PERMANENT_ESTABLISHMENT
        - ENTER_CONTRACTS_WITH_LOCALS
        - CONSIGNMENT_STOCK_ARRANGEMENTS
      title: PhysicalNexusCategory
    PhysicalNexusSource:
      type: string
      enum:
        - USER
        - DEEL
      title: PhysicalNexusSource
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-KEY
    CustomHeader:
      type: apiKey
      in: header
      name: x-organization-id

````