VaultRE

VaultRE Contacts API

Operations related to contacts

GitHub OpenAPI

Operations 70

GET /contacts Retrieve a list of contacts #
POST /contacts Create a contact #
GET /contacts/{id} Retrieve a single contact #
PUT /contacts/{id} Update a single contact #
DELETE /contacts/{id} Delete a contact #
POST /contacts/{id}/sms Send an SMS to this contact #
POST /contacts/sms Send multiple SMS messages to contacts #
GET /contacts/{id}/context Retrieve contextual information about this contact #
GET /contacts/recentlyAccessed Retrieve a list of recently accessed contacts #
GET /contacts/{id}/notes Retrieve a list of notes attached to this contact #
POST /contacts/{id}/notes Add a note to this contact #
POST /contacts/notes Add multiple contact notes #
GET /contacts/{contactid}/notes/{id} Retrieve a single contact note #
PUT /contacts/{contactid}/notes/{id} Update a contact note #
DELETE /contacts/{contactid}/notes/{id} Delete a contact note #
GET /contacts/{id}/categories Retrieve a list of categories to which this contact belongs #
PUT /contacts/{id}/categories Update the categories to which this contact belongs #
POST /contacts/{id}/categories Attach a category to this contact #
GET /contacts/{id}/custom Retrieve a list of custom fields for this contact #
PUT /contacts/{id}/custom Update the custom fields for this contact #
GET /contacts/{id}/files Retrieve a list of files attached to this contact #
POST /contacts/{id}/files Attach a file to this contact #
GET /contacts/{id}/events Retrieve a list of calendar events attached to this contact #
PUT /contacts/{id}/touch Mark the contact record as touched #
GET /contacts/{id}/requirements Retrieve a list of buying/renting requirements for this contact #
POST /contacts/{id}/requirements Add a requirement for this contact #
GET /contacts/{contactid}/requirements/{id} Retrieve a single buying/renting requirement for this contact #
PUT /contacts/{contactid}/requirements/{id} Update a requirement for this contact #
DELETE /contacts/{contactid}/requirements/{id} Delete a buying/renting requirement for the contact #
GET /properties/{id}/sale/{lifeid}/owners Retrieve a list of owners attached to this property life #
PUT /properties/{id}/sale/{lifeid}/owners Update owners for this property life #
POST /properties/{id}/sale/{lifeid}/owners Attach an owner to this property life #
GET /properties/{id}/lease/{lifeid}/landlords Retrieve a list of landlords attached to this property life #
PUT /properties/{id}/lease/{lifeid}/landlords Update landlords for this property life #
POST /properties/{id}/lease/{lifeid}/landlords Attach a landlord to this property life #
GET /properties/{id}/sale/{lifeid}/purchasers Retrieve a list of purchasers attached to this property life #
PUT /properties/{id}/sale/{lifeid}/purchasers Update purchasers for this property life #
POST /properties/{id}/sale/{lifeid}/purchasers Attach a purchaser to this property life #
GET /properties/{id}/lease/{lifeid}/tenancy/{tenancyid}/tenants Retrieve a list of tenants attached to this tenancy #
PUT /properties/{id}/lease/{lifeid}/tenancy/{tenancyid}/tenants Update tenants for this tenancy #
POST /properties/{id}/lease/{lifeid}/tenancy/{tenancyid}/tenants Attach a tenant to this tenancy #
POST /contacts/{id}/email Send an email to this contact #
POST /contacts/email Send multiple emails to contacts #
PUT /contacts/{id}/categories/remove Remove categories from this contact #
POST /contacts/{id}/files/upload Attach a file to this contact #
GET /contacts/{contactid}/files/{id} Retrieve a single file attached to this contact #
DELETE /contacts/{contactid}/files/{id} Delete a file attached to this contact #
DELETE /properties/{propertyid}/lease/{lifeid}/landlords/{id} Remove a landlord from this property life #
DELETE /properties/{propertyid}/lease/{lifeid}/tenancy/{tenancyid}/tenants/{id} Remove a tenant from this property life #
DELETE /properties/{propertyid}/sale/{lifeid}/owners/{id} Remove an owner from this property life #
DELETE /properties/{propertyid}/sale/{lifeid}/purchasers/{id} Remove a purchaser from this property life #
GET /contacts/requirements Retrieve a list of buying/renting requirements across all contacts #
GET /contacts/marketingUsers Retrieve a list of contact marketing users across all contacts #
GET /contacts/currentTenants Retrieve a list of current tenants across all properties #
GET /contacts/currentLandlords Retrieve a list of current landlords across all properties #
GET /contacts/currentOwners Retrieve a list of current owners/vendors across all sale properties #
GET /contacts/currentPurchasers Retrieve a list of current purchasers across all sale properties #
GET /contacts/categories Retrieve a list of contact category mappings across all contacts #
POST /contacts/{id}/access Allow a user to access this contact #
GET /contacts/{id}/activityLog Retrieve the activity log for a contact #
GET /contacts/sourceOfEnquiry Retrieve a list of contact source of enquiry across all contacts #
GET /contacts/dates Retrieve a list of contact dates across all contacts #
GET /contacts/{contactid}/bankAccounts/default Retrieve the default bank account for this contact #
PUT /contacts/{contactid}/bankAccounts/default Update the contact's default bank account #
DELETE /contacts/{contactid}/bankAccounts/default Delete the default bank account for this contact #
GET /contacts/{contactid}/dates Retrieve a list of dates for this contact #
GET /contacts/{contactid}/merged Retrieve a list of contact ID's merged to this contact #
GET /contacts/{contactid}/gdpr Retrieve GDPR consent records for a contact #
POST /contacts/matchingRequirement/count Get a count of contacts matching the provided buy/lease requirement #
POST /contacts/merge Submit a request for two contacts to be merged #

Documentation

📖
APIReference
https://docs.api.vaultre.com.au/swagger/index.html
📖
Documentation
https://docs.api.vaultre.com.au/guide.html
📖
GettingStarted
https://docs.api.vaultre.com.au/basics.html
📖
Authentication
https://docs.api.vaultre.com.au/oauth.html
📖
Documentation
https://docs.api.vaultre.com.au/webhooks.html
📖
Documentation
https://docs.api.vaultre.com.au/integrator.html
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/vaultre/refs/heads/main/authentication/vaultre-authentication.yml
📖
APIReference
https://docs.api.vaultre.com.au/swagger/aggregator/index.html
📖
Documentation
https://docs.api.vaultre.com.au/aggregator.html

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/vaultre/refs/heads/main/openapi/vaultre-contacts-api-openapi.yml

Code Examples

💻
CodeExamples
https://docs.api.vaultre.com.au/samples.html

Other Resources

🔗
ChangeLog
https://docs.api.vaultre.com.au/changelog.html
🔗
SourceCode
https://github.com/VaultGroup/api-samples
🔗
Webhooks
https://docs.api.vaultre.com.au/webhooks.html
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/vaultre/refs/heads/main/data-model/vaultre-data-model.yml
🔗
SourceCode
https://github.com/VaultGroup/api-samples/blob/master/python/create_jwt.py
🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/vaultre/refs/heads/main/scopes/vaultre-scopes.yml
🔗
SourceCode
https://github.com/VaultGroup/api-samples/blob/master/aggregator/client.py
🔗
Webhooks
https://docs.api.vaultre.com.au/aggregator.html

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/vaultre-contacts-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

vaultre-contacts-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Vaultre Contacts API
  contact:
    name: VaultRE
    url: https://www.vaultre.com.au
    email: api@vaultre.com.au
  version: '1.0'
  description: 'Operations tagged contacts across 3 of this provider''s published API definitions: vaultre-api-v1-1-openapi.yml, vaultre-api-v1-2-openapi.yml, vaultre-api-v1-3-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://ap-southeast-2.api.vaultre.com.au/api/v1.1
- url: https://ap-southeast-2.api.vaultre.com.au/api/v1.2
- url: https://ap-southeast-2.api.vaultre.com.au/api/v1.3
tags:
- name: contacts
  description: Operations related to contacts
paths:
  /contacts:
    get:
      tags:
      - contacts
      summary: Retrieve a list of contacts
      description: Retrieve a list of contacts
      operationId: getContacts
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      - $ref: '#/components/parameters/modifiedSince'
      - $ref: '#/components/parameters/modifiedBefore'
      - name: categories
        in: query
        description: Filter contacts belonging to category IDs
        style: form
        explode: false
        schema:
          type: array
          items:
            type: integer
            format: int64
      - name: sort
        in: query
        description: Field by which to sort the results.
        schema:
          type: string
          enum:
          - firstName
          - lastName
          - inserted
          - modified
          - touched
      - $ref: '#/components/parameters/sortOrder'
      responses:
        200:
          description: Contacts retrieved
          content: {}
      security:
      - Api-Key: []
        Bearer: []
    post:
      tags:
      - contacts
      summary: Create a contact
      description: Create a contact
      operationId: addContact
      requestBody:
        description: Contact object
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/AddContact'
        required: true
      responses:
        201:
          description: Contact created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContactExtended'
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError'
      security:
      - Api-Key: []
        Bearer: []
      x-codegen-request-body-name: body
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.1
  /contacts/{id}:
    get:
      tags:
      - contacts
      summary: Retrieve a single contact
      description: Retrieve a single contact
      operationId: getContact
      parameters:
      - name: id
        in: path
        description: ID of the contact
        required: true
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: Contact retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContactExtended'
      security:
      - Api-Key: []
        Bearer: []
    put:
      tags:
      - contacts
      summary: Update a single contact
      description: Update a single contact
      operationId: updateContact
      parameters:
      - name: id
        in: path
        description: ID of the contact
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: Contact object
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateContact'
        required: true
      responses:
        200:
          description: Contact updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContactExtended'
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError'
      security:
      - Api-Key: []
        Bearer: []
      x-codegen-request-body-name: body
    delete:
      tags:
      - contacts
      summary: Delete a contact
      description: Delete a contact
      operationId: deleteContact
      parameters:
      - name: id
        in: path
        description: ID of the contact
        required: true
        schema:
          type: integer
          format: int64
      responses:
        204:
          description: Contact deleted
          content: {}
        400:
          description: Invalid data
          content: {}
        403:
          description: User does not have permission to delete contacts
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SuccessOrError'
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.1
  /contacts/{id}/sms:
    post:
      tags:
      - contacts
      summary: Send an SMS to this contact
      description: Send an SMS to this contact from the authenticated user (charges may apply).
      operationId: sendContactSMS
      requestBody:
        description: SMS object
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SMS'
        required: true
      responses:
        201:
          description: SMS message queued to be sent
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError'
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError'
        403:
          description: User does not have permission to send SMS
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError'
      security:
      - Api-Key: []
        Bearer: []
      x-codegen-request-body-name: body
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.1
  /contacts/sms:
    post:
      tags:
      - contacts
      summary: Send multiple SMS messages to contacts
      description: Send multiple SMS messages to these contacts from the authenticated user (charges may apply). Maximum 50 recipients in any one request.
      operationId: sendBulkContactSMS
      requestBody:
        description: Array of SMS objects
        content:
          application/json: {}
        required: true
      responses:
        201:
          description: SMS messages queued to be sent
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError'
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError'
        403:
          description: User does not have permission to send SMS
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError'
      security:
      - Api-Key: []
        Bearer: []
      x-codegen-request-body-name: body
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.1
  /contacts/{id}/context:
    get:
      tags:
      - contacts
      summary: Retrieve contextual information about this contact
      description: Retrieve contextual information about this contact
      operationId: getContactContext
      parameters:
      - name: id
        in: path
        description: ID of the contact
        required: true
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: Contact context retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContactContext'
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.1
  /contacts/recentlyAccessed:
    get:
      tags:
      - contacts
      summary: Retrieve a list of recently accessed contacts
      description: Retrieve a list of recently accessed contacts
      operationId: getRecentlyAccessedContacts
      responses:
        200:
          description: Contacts retrieved
          content: {}
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.1
  /contacts/{id}/notes:
    get:
      tags:
      - contacts
      summary: Retrieve a list of notes attached to this contact
      description: Retrieve a list of notes attached to this contact
      operationId: getContactNotes
      parameters:
      - name: id
        in: path
        description: ID of the contact
        required: true
        schema:
          type: integer
          format: int64
      - name: types
        in: query
        description: Filter notes with type IDs
        style: form
        explode: false
        schema:
          type: array
          items:
            type: integer
            format: int64
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      - name: sort
        in: query
        description: Field by which to sort the results.
        schema:
          type: string
          enum:
          - inserted
      - $ref: '#/components/parameters/sortOrder'
      responses:
        200:
          description: Contact notes retrieved
          content: {}
      security:
      - Api-Key: []
        Bearer: []
    post:
      tags:
      - contacts
      summary: Add a note to this contact
      description: Add a note to this contact
      operationId: addContactNote
      requestBody:
        description: Contact note object
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddContactNote'
        required: true
      responses:
        201:
          description: Contact note created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContactNote'
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError'
      security:
      - Api-Key: []
        Bearer: []
      x-codegen-request-body-name: body
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.1
  /contacts/notes:
    post:
      tags:
      - contacts
      summary: Add multiple contact notes
      description: Add multiple contact notes in a batch. Maximum 100 notes in any one request.
      operationId: addBulkContactNote
      requestBody:
        description: Bulk contact note object
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkContactNote'
        required: true
      responses:
        201:
          description: Contact notes created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError'
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError'
      security:
      - Api-Key: []
        Bearer: []
      x-codegen-request-body-name: body
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.1
  /contacts/{contactid}/notes/{id}:
    get:
      tags:
      - contacts
      summary: Retrieve a single contact note
      description: Retrieve a single contact note
      operationId: getContactNote
      parameters:
      - name: contactid
        in: path
        description: ID of the contact
        required: true
        schema:
          type: integer
          format: int64
      - name: id
        in: path
        description: ID of the note
        required: true
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: Contact note retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContactNote'
      security:
      - Api-Key: []
        Bearer: []
    put:
      tags:
      - contacts
      summary: Update a contact note
      description: Update a contact note
      operationId: updateContactNote
      parameters:
      - name: contactid
        in: path
        description: ID of the contact
        required: true
        schema:
          type: integer
          format: int64
      - name: id
        in: path
        description: ID of the note
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: Contact Note object
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateContactNote'
        required: true
      responses:
        200:
          description: Note updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContactNote'
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError'
        403:
          description: User does not have permission to modify contact notes or note is read-only
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError'
      security:
      - Api-Key: []
        Bearer: []
      x-codegen-request-body-name: body
    delete:
      tags:
      - contacts
      summary: Delete a contact note
      description: Delete a contact note
      operationId: deleteContactNote
      parameters:
      - name: contactid
        in: path
        description: ID of the contact
        required: true
        schema:
          type: integer
          format: int64
      - name: id
        in: path
        description: ID of the note
        required: true
        schema:
          type: integer
          format: int64
      responses:
        204:
          description: Contact Note deleted
          content: {}
        400:
          description: Invalid data
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SuccessOrError'
        403:
          description: User does not have permission to delete contact notes or note is read-only
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SuccessOrError'
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.1
  /contacts/{id}/categories:
    get:
      tags:
      - contacts
      summary: Retrieve a list of categories to which this contact belongs
      description: Retrieve a list of categories to which this contact belongs
      operationId: getCategoriesContact
      parameters:
      - name: id
        in: path
        description: ID of the contact
        required: true
        schema:
          type: integer
          format: int64
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      - name: sort
        in: query
        description: Field by which to sort the results.
        schema:
          type: string
          enum:
          - name
      - $ref: '#/components/parameters/sortOrder'
      responses:
        200:
          description: Contact categories retrieved
          content: {}
      security:
      - Api-Key: []
        Bearer: []
    put:
      tags:
      - contacts
      summary: Update the categories to which this contact belongs
      description: Update the categories to which this contact belongs
      operationId: updateCategoriesContact
      parameters:
      - name: id
        in: path
        description: ID of the contact
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: Items object containing array of contact category IDs
        content:
          application/json: {}
        required: true
      responses:
        200:
          description: Contact categories updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError'
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError'
      security:
      - Api-Key: []
        Bearer: []
      x-codegen-request-body-name: body
    post:
      tags:
      - contacts
      summary: Attach a category to this contact
      description: Attach a category to this contact
      operationId: attachCategoryContact
      parameters:
      - name: id
        in: path
        description: ID of the contact
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: Category ID object
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ID'
        required: true
      responses:
        200:
          description: Contact category attached
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError'
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError'
      security:
      - Api-Key: []
        Bearer: []
      x-codegen-request-body-name: body
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.1
  /contacts/{id}/custom:
    get:
      tags:
      - contacts
      summary: Retrieve a list of custom fields for this contact
      description: Retrieve a list of custom fields for this contact
      operationId: getContactCustomFields
      parameters:
      - name: id
        in: path
        description: ID of the contact
        required: true
        schema:
          type: integer
          format: int64
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      responses:
        200:
          description: Custom fields retrieved
          content: {}
      security:
      - Api-Key: []
        Bearer: []
    put:
      tags:
      - contacts
      summary: Update the custom fields for this contact
      description: Update the custom fields for this contact
      operationId: updateContactCustomFields
      parameters:
      - name: id
        in: path
        description: ID of the contact
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: Items object containing array of custom fields
        content:
          application/json: {}
        required: true
      responses:
        200:
          description: Custom fields updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError'
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError'
      security:
      - Api-Key: []
        Bearer: []
      x-codegen-request-body-name: body
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.1
  /contacts/{id}/files:
    get:
      tags:
      - contacts
      summary: Retrieve a list of files attached to this contact
      description: Retrieve a list of files attached to this contact
      operationId: getContactFiles
      parameters:
      - name: id
        in: path
        description: ID of the contact
        required: true
        schema:
          type: integer
          format: int64
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      - name: sort
        in: query
        description: Field by which to sort the results.
        schema:
          type: string
          enum:
          - inserted
      - $ref: '#/components/parameters/sortOrder'
      responses:
        200:
          description: Files retrieved
          content: {}
      security:
      - Api-Key: []
        Bearer: []
    post:
      tags:
      - contacts
      summary: Attach a file to this contact
      description: Attach a file to this contact. This endpoint is suitable for smaller files (<5MB). For larger files use POST /contacts/{id}/files/upload
      operationId: addContactFile
      parameters:
      - name: id
        in: path
        description: ID of the contact
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        content:
          multipart/form-data:
            schema:
              required:
              - file
              properties:
                file:
                  type: string
                  description: The file to be uploaded
                  format: binary
        required: true
      responses:
        201:
          description: File attached successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContactFile'
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError'
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.1
  /contacts/{id}/events:
    get:
      tags:
      - contacts
      summary: Retrieve a list of calendar events attached to this contact
      description: Retrieve a list of calendar events attached to this contact
      operationId: getContactEvents
      parameters:
      - name: id
        in: path
        description: ID of the contact
        required: true
        schema:
          type: integer
          format: int64
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      - name: sort
        in: query
        description: Field by which to sort the results.
        schema:
          type: string
          enum:
          - start
      - $ref: '#/components/parameters/sortOrder'
      responses:
        200:
          description: Calendar events retrieved
          content: {}
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.1
  /contacts/{id}/touch:
    put:
      tags:
      - contacts
      summary: Mark the contact record as touched
      description: Mark the contact record as touched
      operationId: touchContact
      parameters:
      - name: id
        in: path
        description: ID of the contact
        required: true
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: Contact touched
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError'
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError'
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.1
  /contacts/{id}/requirements:
    get:
      tags:
      - contacts
      summary: Retrieve a list of buying/renting requirements for this contact
      description: Retrieve a list of buying/renting requirements for this contact
      operationId: getContactRequirements
      parameters:
      - name: id
        in: path
        description: ID of the contact
        required: true
        schema:
          type: integer
          format: int64
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      - name: sort
        in: query
        description: Field by which to sort the results.
        schema:
          type: string
          enum:
          - inserted
          - modified
      - $ref: '#/components/parameters/sortOrder'
      responses:
        200:
          description: Requirements retrieved
          content: {}
      security:
      - Api-Key: []
        Bearer: []
    post:
      tags:
      - contacts
      summary: Add a requirement for this contact
      description: Add a requirement for this contact
      operationId: addContactRequirement
      parameters:
      - name: id
        in: path
        description: ID of the contact
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: Contact Requirement object
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddUpdateContactRequirement'
        required: true
      responses:
        201:
          description: Contact Requirement created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContactRequirement'
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError'
      security:
      - Api-Key: []
        Bearer: []
      x-codegen-request-body-name: body
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.1
  /contacts/{contactid}/requirements/{id}:
    get:
      tags:
      - contacts
      summary: Retrieve a single buying/renting requirement for this contact
      description: Retrieve a single buying/renting requirement for this contact
      operationId: getContactRequirement
      parameters:
      - name: contactid
        in: path
        description: ID of the contact
        required: true
        schema:
          type: integer
          format: int64
      - name: id
        in: path
        description: ID of the requirement
        required: true
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: Contact requirement retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContactRequirement'
      security:
      - Api-Key: []
        Bearer: []
    put:
      tags:
      - contacts
      summary: Update a requirement for this contact
      description: Update a requirement for this contact
      operationId: updateContactRequirement
      parameters:
      - name: contactid
        in: path
        description: ID of the contact
        required: true
        schema:
          type: integer
          format: int64
      - name: id
        in: path
        description: ID of the requirement
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: Contact Requirement object
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddUpdateContactRequirement'
        required: true
      responses:
        200:
          description: Contact Requirement updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContactRequirement'
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError'
      security:
      - Api-Key: []
        Bearer: []
      x-codegen-request-body-name: body
    delete:
      tags:
      - contacts
      summary: Delete a buying/renting requirement for the contact
      description: Delete a buying/renting requirement for the contact
      operationId: deleteContactRequirement
      parameters:
      - name: contactid
        in: path
        description: ID of the contact
        required: true
        schema:
          type: integer
          format: int64
      - name: id
        in: path
        description: ID of the requirement
        required: true
        schema:
          type: integer
          format: int64
      responses:
        204:
          description: Requirement deleted
          content: {}
        400:
          description: Invalid data
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SuccessOrError'
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.1
  /properties/{id}/sale/{lifeid}/owners:
    get:
      tags:
      - contacts
      summary: Retrieve a list of owners attached to this property life
      description: Retrieve a list of owners attached to this property life
      operationId: getPropertyLifeOwners
      parameters:
      - name: id
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the property life
        required: true
        schema:
          type: integer
          format: int64
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      responses:
        200:
          description: Owners retrieved
          content: {}
      security:
      - Api-Key: []
        Bearer: []
    put:
      tags:
      - contacts
      summary: Update owners for this property life
      description: Update owners for this property life
      operationId: updateOwnersForProperty
      parameters:
      - name: id
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the property life
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: Items object containing array of contact IDs
        content:
          application/json: {}
        required: true
      responses:
        200:
          description: Owners updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError'
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError'
      security:
      - Api-Key: []
        Bearer: []
      x-codegen-request-body-name: body
    post:
      tags:
      - contacts
      summary: Attach an owner to this property life
      description: Attach an owner to this property life
      operationId: attachOwnerToProperty
      parameters:
      - name: id
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the property life
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: Contact ID object
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ID'
        required: true
      responses:
        200:
          description: Owner attached
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError'
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError'
      security:
      - Api-Key: []
        Bearer: []
      x-codegen-request-body-name: body
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.1
  /properties/{id}/lease/{lifeid}/landlords:
    get:
      tags:
      - contacts
      summary: Retrieve a list of landlords attached to this property life
      description: Retrieve a list of landlords attached to this property life
      operationId: getPropertyLifeLandlords
      parameters:
      - 

# --- truncated at 32 KB (130 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/vaultre/refs/heads/main/openapi/vaultre-contacts-api-openapi.yml