Skip to main content

List Company Addresses

GET 
/institutions/:institutionId/addresses

List Company Addresses

Request​

Path Parameters

    institutionId stringrequired

Query Parameters

    limit number

    Number of items to return

    offset number

    Number of items to skip

    filter.type string

    Type

    filter.isPrimary string

    Is Primary

    filter.name string

    Name

    filter.organization string

    Organization

    filter.address1 string

    Address1

    filter.address2 string

    Address2

    filter.address3 string

    Address3

    filter.city string

    City

    filter.region string

    Region

    filter.postalCode string

    Postal Code

    filter.country string

    Country

    filter.phoneNumber string

    Phone Number

    filter.notes string

    Notes

    filter.id string

    Id

    filter.tags string

    Tags

    filter.createdAt string

    Created At

    filter.updatedAt string

    Updated At

    filter.deletedAt string

    Deleted At

    filter.deleted string

    Deleted

    filter.createdBy string

    Created By

    filter.updatedBy string

    Updated By

    filter.deletedBy string

    Deleted By

    include string[]

    Possible values: [type, isPrimary, name, organization, address1, address2, address3, city, region, postalCode, country, phoneNumber, notes, id, tags, createdAt, updatedAt, deletedAt, deleted, createdBy, updatedBy, deletedBy]

Responses​

List of Company Addresses

Schema

  • Array [

    • type string

    Type

    isPrimary string

    Is Primary

    name string

    Name

    organization string

    Organization

    address1 string

    Address1

    address2 string

    Address2

    address3 string

    Address3

    city string

    City

    region string

    Region

    postalCode string

    Postal Code

    country string

    Country

    phoneNumber string

    Phone Number

    notes string

    Notes

    tags string

    Tags

    id string

    Id

    createdAt string

    Created At

    updatedAt string

    Updated At

    deletedAt string

    Deleted At

    deleted string

    Deleted

    createdBy string

    Created By

    updatedBy string

    Updated By

    deletedBy string

    Deleted By

  • ]

Loading...