VaultRE

VaultRE User API

Operations related to users

GitHub OpenAPI

Operations 39

GET /user Retrieve information about the authenticated user #
PUT /user Update the authenticated user #
GET /user/subscriptions Retrieve active subscriptions for the authenticated user #
GET /user/teams Retrieve a list of teams to which the authenticated user belongs #
GET /user/summary/grossCommission Retrieve a summary of recent gross commission for the authenticated user #
GET /user/upcomingOfferConditions Retrieve a list of upcoming offer conditions for the authenticated user #
GET /user/upcomingOpenHomes Retrieve a list of upcoming open homes for the authenticated user #
PUT /user/credentials Update the credentials for the authenticated user #
GET /user/signature Retrieve the authenticated user's signature #
PUT /user/signature Update the signature for the authenticated user #
GET /user/photo Retrieve the authenticated user's photograph #
PUT /user/photo Update the photo for the authenticated user #
GET /account Retrieve information about the authenticated account #
GET /account/users Retrieve a list of users in the authenticated account #
POST /account/users Add a new user in the authenticated account #
GET /account/users/{id} Retrieve a single user from the account #
PUT /account/users/{id} Update a user in the authenticated account #
DELETE /account/users/{id} Delete a user in the authenticated account #
GET /account/users/{id}/teams Retrieve a list of teams to which this user belongs #
GET /account/teams Retrieve a list of teams in the authenticated account #
GET /account/teams/{id} Retrieve a single team from the account #
GET /account/enquirySources Retrieve a list of enquiry sources in the authenticated account #
POST /account/enquirySources Add a new Enquiry Source type #
GET /account/enquirySources/{id} Retrieve a single enquiry source #
PUT /account/enquirySources/{id} Update an Enquiry Source type #
GET /account/pricing Retrieve pricing information for the authenticated account #
DELETE /logout Log out from the current user session #
POST /verifyPassword Verify the authenticated user's password #
GET /user/tenancyInspections Retrieve a list of upcoming and recent inspections for the authenticated user #
GET /account/upcomingOpenHomes Retrieve a list of upcoming open homes for the authenticated account #
GET /account/folders/filingCabinet Retrieve a list of folders available in the Filing Cabinet for this account #
GET /account/branches Retrieve a list of branches configured for this account #
GET /account/propertyPortals Retrieve a list of property portals for this account #
GET /account/trustAccounts Retrieve a list of trust accounts for this account #
GET /sso Generate a single-sign-on URL #
GET /account/contactDateTypes Retrieve a list of available contact date types for this account #
GET /user/oAuthLoginUrl Get the oAuth sign-in target URL for this username #
GET /account/oAuthLoginUrl Get the oAuth sign-in target URL for this username (office level oAuth exchange) #
GET /account/customRegions Retrieve a list of custom regions for this account #

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-user-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-user-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-user-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Vaultre User API
  contact:
    name: VaultRE
    url: https://www.vaultre.com.au
    email: api@vaultre.com.au
  version: '1.0'
  description: 'Operations tagged user 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: user
  description: Operations related to users
paths:
  /user:
    get:
      tags:
      - user
      summary: Retrieve information about the authenticated user
      description: Retrieve information about the authenticated user
      operationId: getUser
      responses:
        200:
          description: User retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
      security:
      - Api-Key: []
        Bearer: []
    put:
      tags:
      - user
      summary: Update the authenticated user
      description: Update the authenticated user
      operationId: updateUser
      requestBody:
        description: User object
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateUser'
        required: true
      responses:
        200:
          description: User updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
        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
  /user/subscriptions:
    get:
      tags:
      - user
      summary: Retrieve active subscriptions for the authenticated user
      description: Retrieve active subscriptions for the authenticated user
      operationId: getUserSubscriptions
      responses:
        200:
          description: User subscriptions retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserSubscriptions'
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.1
  /user/teams:
    get:
      tags:
      - user
      summary: Retrieve a list of teams to which the authenticated user belongs
      description: Retrieve a list of teams to which the authenticated user belongs
      operationId: getUserTeams
      parameters:
      - name: sort
        in: query
        description: Field by which to sort the results.
        schema:
          type: string
          enum:
          - name
      - $ref: '#/components/parameters/sortOrder'
      responses:
        200:
          description: User teams retrieved
          content: {}
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.1
  /user/summary/grossCommission:
    get:
      tags:
      - user
      summary: Retrieve a summary of recent gross commission for the authenticated user
      description: Retrieve a month by month summary of recent gross commission (previous six months) for the authenticated user
      operationId: getUserSummaryGrossCommission
      responses:
        200:
          description: Summary retrieved
          content: {}
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.1
  /user/upcomingOfferConditions:
    get:
      tags:
      - user
      summary: Retrieve a list of upcoming offer conditions for the authenticated user
      description: Retrieve a list of upcoming offer conditions for the authenticated user
      operationId: getUserUpcomingOfferConditions
      parameters:
      - name: days
        in: query
        description: Number of days to look ahead and back (default 8)
        schema:
          type: integer
          format: int64
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      responses:
        200:
          description: Conditions retrieved
          content: {}
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.1
  /user/upcomingOpenHomes:
    get:
      tags:
      - user
      summary: Retrieve a list of upcoming open homes for the authenticated user
      description: Retrieve a list of upcoming open homes for the authenticated user
      operationId: getUserUpcomingOpenHomes
      parameters:
      - name: days
        in: query
        description: Number of days to look ahead and back (default 7)
        schema:
          type: integer
          format: int64
      - name: includeRecent
        in: query
        description: Include recently completed open homes
        schema:
          type: boolean
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      responses:
        200:
          description: Open Homes retrieved
          content: {}
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.1
  /user/credentials:
    put:
      tags:
      - user
      summary: Update the credentials for the authenticated user
      description: Update the credentials for the authenticated user
      operationId: updateUserCredentials
      requestBody:
        description: Credential object
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Credential'
        required: true
      responses:
        200:
          description: User credentials 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
  /user/signature:
    get:
      tags:
      - user
      summary: Retrieve the authenticated user's signature
      description: Retrieve the authenticated user's signature
      operationId: getUserSignature
      responses:
        200:
          description: Signature retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Signature'
      security:
      - Api-Key: []
        Bearer: []
    put:
      tags:
      - user
      summary: Update the signature for the authenticated user
      description: Update the signature for the authenticated user
      operationId: updateUserSignature
      requestBody:
        content:
          multipart/form-data:
            schema:
              required:
              - file
              properties:
                file:
                  type: string
                  description: PNG image of the signature
                  format: binary
        required: true
      responses:
        200:
          description: User signature updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Signature'
        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
  /user/photo:
    get:
      tags:
      - user
      summary: Retrieve the authenticated user's photograph
      description: Retrieve the authenticated user's photograph
      operationId: getUserPhoto
      responses:
        200:
          description: Photo retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserPhoto'
      security:
      - Api-Key: []
        Bearer: []
    put:
      tags:
      - user
      summary: Update the photo for the authenticated user
      description: Update the photo for the authenticated user
      operationId: updateUserPhoto
      requestBody:
        content:
          multipart/form-data:
            schema:
              required:
              - file
              properties:
                file:
                  type: string
                  description: The photo file to be uploaded
                  format: binary
        required: true
      responses:
        200:
          description: User photo updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserPhoto'
        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
  /account:
    get:
      tags:
      - user
      summary: Retrieve information about the authenticated account
      description: Retrieve information about the authenticated account
      operationId: getAccount
      responses:
        200:
          description: User retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Account'
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.1
  /account/users:
    get:
      tags:
      - user
      summary: Retrieve a list of users in the authenticated account
      description: Retrieve a list of users in the authenticated account
      operationId: getAccountUsers
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      - name: team
        in: query
        description: Filter users belonging to the given team ID
        schema:
          type: integer
          format: int64
      - name: sort
        in: query
        description: Field by which to sort the results.
        schema:
          type: string
          enum:
          - firstname
          - lastname
          - inserted
      - $ref: '#/components/parameters/sortOrder'
      responses:
        200:
          description: Account users retrieved
          content: {}
      security:
      - Api-Key: []
        Bearer: []
    post:
      tags:
      - user
      summary: Add a new user in the authenticated account
      description: Add a new user
      operationId: addUser
      requestBody:
        description: User object
        content:
          application/json:
            schema:
              type: object
              required:
              - firstName
              - lastName
              - email
              - staffTypeId
              properties:
                firstName:
                  type: string
                lastName:
                  type: string
                email:
                  type: string
                  format: email
                username:
                  type: string
                password:
                  type: string
                staffTypeId:
                  type: integer
                  format: int64
                  enum:
                  - 1
                  - 2
                  - 3
                  - 4
                  description: '1: Salesperson, 2: Administration, 3: Property Manager, 4: Principal'
                position:
                  type: string
                phoneNumbers:
                  type: array
                  items:
                    $ref: '#/components/schemas/PhoneNumber_3'
                profile:
                  type: string
                externalReference:
                  type: string
                ssoIdentifier:
                  type: string
                adminAccess:
                  type: boolean
                permissions:
                  type: object
                  properties:
                    canLogin:
                      type: boolean
      responses:
        201:
          description: User created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User_3'
        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
  /account/users/{id}:
    get:
      tags:
      - user
      summary: Retrieve a single user from the account
      description: Retrieve a single user from the account
      operationId: getAccountUser
      parameters:
      - name: id
        in: path
        description: ID of the user
        required: true
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: User retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
      security:
      - Api-Key: []
        Bearer: []
    put:
      tags:
      - user
      summary: Update a user in the authenticated account
      description: Update a user
      operationId: updateUser
      parameters:
      - name: id
        in: path
        description: ID of user
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: User object
        content:
          application/json:
            schema:
              type: object
              properties:
                firstName:
                  type: string
                lastName:
                  type: string
                email:
                  type: string
                  format: email
                position:
                  type: string
                username:
                  type: string
                password:
                  type: string
                phoneNumbers:
                  type: array
                  items:
                    $ref: '#/components/schemas/PhoneNumber_3'
                profile:
                  type: string
                externalReference:
                  type: string
                ssoIdentifier:
                  type: string
                adminAccess:
                  type: boolean
                permissions:
                  type: object
                  properties:
                    canLogin:
                      type: boolean
      responses:
        200:
          description: User updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User_3'
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError'
      security:
      - Api-Key: []
        Bearer: []
      x-codegen-request-body-name: body
    delete:
      tags:
      - user
      summary: Delete a user in the authenticated account
      description: Delete a user in the authenticated account
      operationId: deleteUser
      parameters:
      - name: id
        in: path
        description: ID of user
        required: true
        schema:
          type: integer
          format: int64
      responses:
        204:
          description: User deleted
          content: {}
        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
  /account/users/{id}/teams:
    get:
      tags:
      - user
      summary: Retrieve a list of teams to which this user belongs
      description: Retrieve a list of teams to which this user belongs
      operationId: getAccountUserTeams
      parameters:
      - $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: User teams retrieved
          content: {}
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.1
  /account/teams:
    get:
      tags:
      - user
      summary: Retrieve a list of teams in the authenticated account
      description: Retrieve a list of teams in the authenticated account
      operationId: getAccountTeams
      parameters:
      - $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: Account teams retrieved
          content: {}
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.1
  /account/teams/{id}:
    get:
      tags:
      - user
      summary: Retrieve a single team from the account
      description: Retrieve a single team from the account
      operationId: getAccountTeam
      parameters:
      - name: id
        in: path
        description: ID of the team
        required: true
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: Team retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Team'
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.1
  /account/enquirySources:
    get:
      tags:
      - user
      summary: Retrieve a list of enquiry sources in the authenticated account
      description: Retrieve a list of enquiry sources in the authenticated account
      operationId: getAccountEnquirySources
      parameters:
      - name: sort
        in: query
        description: Field by which to sort the results.
        schema:
          type: string
          enum:
          - name
      - $ref: '#/components/parameters/sortOrder'
      responses:
        200:
          description: Enquiry Sources retrieved
          content: {}
      security:
      - Api-Key: []
        Bearer: []
    post:
      tags:
      - user
      summary: Add a new Enquiry Source type
      description: Add a new Enquiry Source type
      operationId: addEnquirySource
      requestBody:
        description: Enquiry Source object
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddUpdateEnquirySource'
        required: true
      responses:
        201:
          description: Enquiry Source created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnquirySource'
        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
  /account/enquirySources/{id}:
    get:
      tags:
      - user
      summary: Retrieve a single enquiry source
      description: Retrieve a single enquiry source
      operationId: getAccountEnquirySource
      parameters:
      - name: id
        in: path
        description: ID of the enquiry source
        required: true
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: Enquiry Source retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnquirySource'
      security:
      - Api-Key: []
        Bearer: []
    put:
      tags:
      - user
      summary: Update an Enquiry Source type
      description: Update an Enquiry Source type
      operationId: updateEnquirySource
      parameters:
      - name: id
        in: path
        description: ID of the enquiry source
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: Enquiry Source object
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddUpdateEnquirySource'
        required: true
      responses:
        200:
          description: Enquiry Source updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnquirySource'
        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
  /account/pricing:
    get:
      tags:
      - user
      summary: Retrieve pricing information for the authenticated account
      description: Retrieve pricing information for the authenticated account
      operationId: getAccountPricing
      responses:
        200:
          description: Account pricing retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountPricing'
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.1
  /logout:
    delete:
      tags:
      - user
      summary: Log out from the current user session
      description: Log out from the current user session
      operationId: logout
      responses:
        204:
          description: Logged out successfully
          content: {}
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.1
  /verifyPassword:
    post:
      tags:
      - user
      summary: Verify the authenticated user's password
      description: Verify the authenticated user's password
      operationId: verifyUserPassword
      requestBody:
        description: User's password
        content:
          application/json: {}
        required: true
      responses:
        200:
          description: API Call completed successfully
          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
  /user/tenancyInspections:
    get:
      tags:
      - user
      summary: Retrieve a list of upcoming and recent inspections for the authenticated user
      description: Retrieve a list of upcoming and recent inspections for the authenticated user
      operationId: getUserTenancyInspections
      parameters:
      - name: days
        in: query
        description: Number of days to look ahead and back (default 7). Only used if start and end are undefined.
        schema:
          type: integer
          format: int64
      - name: includeRecent
        in: query
        description: Include recently completed inspections. Used in conjuction with days argument.
        schema:
          type: boolean
      - name: start
        in: query
        description: Filter inspections starting on or after this datetime. Takes precendent over days argument.
        schema:
          type: string
          format: date-time
      - name: end
        in: query
        description: Filter inspections starting before this datetime. Takes precendent over days argument.
        schema:
          type: string
          format: date-time
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      responses:
        200:
          description: Inspections retrieved
          content: {}
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.2
  /account/upcomingOpenHomes:
    get:
      tags:
      - user
      summary: Retrieve a list of upcoming open homes for the authenticated account
      description: Retrieve a list of upcoming open homes for the authenticated account
      operationId: getAccountUpcomingOpenHomes
      parameters:
      - name: days
        in: query
        description: Number of days to look ahead and back (default 7)
        schema:
          type: integer
          format: int64
      - name: includeRecent
        in: query
        description: Include recently completed open homes
        schema:
          type: boolean
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      responses:
        200:
          description: Open Homes retrieved
          content: {}
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.2
  /account/folders/filingCabinet:
    get:
      tags:
      - user
      summary: Retrieve a list of folders available in the Filing Cabinet for this account
      description: Retrieve a list of folders available in the Filing Cabinet for this account
      operationId: getAccountFilingCabinetFolders
      parameters:
      - name: sort
        in: query
        description: Field by which to sort the results.
        schema:
          type: string
          enum:
          - name
      - $ref: '#/components/parameters/sortOrder'
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      responses:
        200:
          description: Folders retrieved
          content: {}
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.2
  /account/branches:
    get:
      tags:
      - user
      summary: Retrieve a list of branches configured for this account
      description: Retrieve a list of branches configured for this account
      operationId: getAccountBranches
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      responses:
        200:
          description: Branches retrieved
          content: {}
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.2
  /account/propertyPortals:
    get:
      tags:
      - user
      summary: Retrieve a list of property portals for this account
      description: Retrieve a list of property portals to which this account can publish properties
      operationId: getAccountPortals
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      responses:
        200:
          description: Portals retrieved
          content: {}
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.2
  /account/trustAccounts:
    get:
      tags:
      - user
      summary: Retrieve a list of trust accounts for this account
      description: Retrieve a list of trust accounts for this account
      operationId: getTrustAccounts
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      responses:
        200:
          description: Trust accounts retrieved
          content: {}
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.2
  /sso:
    get:
      tags:
      - user
      summary: Generate a single-sign-on URL
      description: Generate a single-sign-on URL for the VaultRE web application
      operationId: getSSOUrl
      responses:
        200:
          description: URL retrieved
          content: {}
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.2
  /account/contactDateTypes:
    get:
      tags:
      - user
      summary: Retrieve a list of available contact date types for this account
      description: Retrieve a list of available contact date types for this account
      operationId: getContactDateTypes
      parameters:
      - $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: Date types retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/ContactDateType'
                  totalItems:
                    type: integer
                    format: int64
                  totalPages:
                    type: integer
                    format: int64
                  urls:
                    $ref: '#/components/schemas/Urls'
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.3
  /user/oAuthLoginUrl:
    get:
      tags:
      - user
      summary: Get the oAuth sign-in target URL for this username
      description: For the given username, find the correct oAuth sign-in URL.
      operationId: getOAuthLoginUrl
      parameters:
      - name: username
        in: query
        description: The user's username
        required: true
        schema:
          type: string
      responses:
        200:
          description: URL retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  url:
                    type: string
      security:
      - Api-Key: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.3
  /account/oAuthLoginUrl:
    get:
      tags:
      - user
      summary: Get the oAuth sign-in target URL for this username (office level oAuth exchange)
      description: For the given username, find the correct oAuth sign-in URL.
      operationId: getOAuthLoginUrlAccount
      parameters:
      - name: username
        in: query
        description: The user's username
        required: true
        schema:
          type: string
      responses:
        200:
          description: URL retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  url:
                    type: string
      security:
      - Api-Key: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.3
  /account/customRegions:
    get:
      tags:
      - user
      summary: Retrieve a list of custom regions for this account
      description: Retrieve a list of custom regions for this account
      operationId: getCustomRegions
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/

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