Skip to main content

List Company Contacts

GET 
/institutions/:institutionId/contacts

List Company Contacts

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.firstName string

    First Name

    filter.lastName string

    Last Name

    filter.title string

    Title

    filter.email string

    Email

    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, firstName, lastName, title, email, phoneNumber, notes, id, tags, createdAt, updatedAt, deletedAt, deleted, createdBy, updatedBy, deletedBy]

Responses​

List of Company Contacts

Schema

  • Array [

    • type string

    Type

    Possible values: [Primary, Billing, Other]

    firstName string

    First Name

    lastName string

    Last Name

    title string

    Title

    email string

    Email

    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...