Skip to main content

Get Addresses by type

GET 
/companies/:lookupKey/:lookupValue/addresses/

Use this endpoint to retrieve a list of all company addresses. Addresses can be filtered by type.

Request​

Path Parameters

    lookupKey stringrequired

    Lookup key. Read more about company lookup keys

    lookupValue stringrequired

    The value of the key (id or sourceId)

Query Parameters

    type string

    Optional. Only retrieve a certain type of address. Possible values:

    delivery invoice

Responses​

Get Addresses by type - 200

Response Headers

  • Alt-Svc

    string

  • Via

    string

  • alt-svc

    string

  • content-length

    string

  • date

    string

  • return-format

    string

  • x-request-id

    string

Schema

    data

    object[]

  • Array [

    • active string
    city string
    code string
    company string
    country string
    email string
    fax string
    firstName string
    gender string
    icp string
    id number
    isDefault string
    lastName string
    middleName string
    mobile string
    name string
    notes string
    number string
    numberExtension string
    phone string
    postalCode string
    region string
    street string
    type string
    url string

  • ]

    • messages undefined[]
    total number
Loading...