### GET /fms/leads

Source: https://docs.api.vaultre.com.au/swagger/vaultre.yaml

Get a list of FMS leads

```markdown
### Parameters

- **page** (integer (int64), query, optional): Page number of results
- **pagesize** (integer (int64), query, optional): Number of records to be returned in each page.

### Responses

#### 200 - Leads retrieved

- **items** (array (FMSLead))
  Array items:
    - **id** (number (int64))
    - **contact** (object)
      - **name** (string)
      - **phone** (string)
      - **email** (string)
      - **doNotMail** (boolean)
      - **description** (string)
    - **property** (object)
      - **streetAddress** (string)
      - **suburb** (string)
      - **state** (string)
      - **bedrooms** (integer (int64))
      - **bathrooms** (integer (int64))
      - **carParkingSpaces** (integer (int64))
      - **contactIsOwner** (boolean)
    - **appraisalRequired** (boolean)
    - **appraisalType** (string)
    - **source** (string)
- **totalItems** (integer (int64))
- **totalPages** (integer (int64))
- **urls** (object)
  - **previous** (string)
  - **next** (string)
  - **self** (string)

### Example Usage

```bash
curl -X GET "https://ap-southeast-2.api.vaultre.com.au/api/v1.3/fms/leads?page=0&pagesize=50"
```

```

--------------------------------

### GET /tasks

Source: https://docs.api.vaultre.com.au/swagger/vaultre.yaml

Get a list of tasks for the account or user

```markdown
### Parameters

- **startingAfter** (string (date-time), query, optional): Filter tasks starting on or after this datetime
- **startingBefore** (string (date-time), query, optional): Filter tasks starting before this datetime
- **userid** (integer (int64), query, optional): Filter tasks assigned to this user ID
- **completed** (boolean, query, optional): Filter tasks by completed status
- **insertedSince** (string (date-time), query, optional): Filter results inserted since this datetime
- **insertedBefore** (string (date-time), query, optional): Filter results inserted before this datetime
- **page** (integer (int64), query, optional): Page number of results
- **pagesize** (integer (int64), query, optional): Number of records to be returned in each page.
- **sort** (string (start), query, optional): Field by which to sort the results.
- **sortOrder** (string (asc|desc), query, optional): Order by which to sort the results. Used in conjunction with sort parameter.

### Responses

#### 200 - Tasks retrieved

- **items** (array (Task))
  Array items:
    - **id** (number (int64))
    - **subject** (string)
    - **description** (string)
    - **inserted** (string (date-time))
    - **completed** (boolean)
    - **start** (string (date-time))
    - **contact** (object)
      - **id** (integer (int64))
      - **name** (string)
    - **contactNote** (object)
      - **id** (integer (int64))
      - **inserted** (string (date-time))
      - **modified** (string (date-time))
      - **body** (string)
      - **readOnly** (boolean)
      - **contact** (object)
        - **id** (integer (int64))
      - **insertedBy** (object)
        - **id** (integer (int64))
        - **firstName** (string)
        - **lastName** (string)
        - **username** (string)
        - **email** (string (email))
        - **adminAccess** (boolean)
        - **position** (string)
        - **role** (string (commercialSalesAndLeasing|residentialSales|propertyManagement)) ("commercialSalesAndLeasing"|"residentialSales"|"propertyManagement")
        - **photo** (object)
          - **original** (string)
          - **thumb_360** (string)
        - **lastLogin** (string (date-time))
        - **phoneNumbers** (array (PhoneNumber))
          Array items:
            - **number** (string)
            - **typeCode** (string (H|W|M|F|D)) ("H"|"W"|"M"|"F"|"D")
            - **type** (string (Home|Work|Mobile|Facsimile|Direct)) ("Home"|"Work"|"Mobile"|"Facsimile"|"Direct")
            - **comment** (string)
        - **profile** (string)
        - **permissions** (object)
          - **settings** (boolean)
          - **accessPropertyManagement** (boolean)
          - **accessSales** (boolean)
          - **canLogin** (boolean)
          - **deleteContacts** (boolean)
          - **deleteProperties** (boolean)
          - **globalActionListsReadWrite** (boolean)
          - **globalContactsReadWrite** (boolean)
          - **globalNotesRead** (boolean)
          - **globalNotesReadWrite** (boolean)
          - **globalPropertiesRead** (boolean)
          - **globalPropertiesReadWrite** (boolean)
          - **globalTasksReadWrite** (boolean)
          - **sendSMS** (boolean)
          - **accessPropertyFinancials** (boolean)
          - **accessAlarmDetails** (boolean)
          - **modifyWebsiteContent** (boolean)
          - **editMarketingContact** (boolean)
        - **websiteUrl** (string)
        - **showOnWeb** (boolean)
        - **externalReference** (string)
        - **ssoIdentifier** (string)
        - **signature** (string)
        - **account** (object)
        - **hideMobileFromPortal** (boolean)
      - **type** (object)
        - **id** (integer (int64))
        - **name** (string)
        - **colour** (string)
        - **defaultReadOnly** (boolean)
        - **pinned** (boolean)
        - **purpose** (object)
      - **reminder** (object)
        - **date** (string (date-time))
        - **user** (object)
      - **propertyFeedback** (object)
        - **id** (integer (int64))
        - **property** (object)
          - **id** (number (int64))
          - **displayAddress** (string)
          - **saleLifeId** (number (int64))
          - **leaseLifeId** (number (int64))
          - **class** (object)
            - **id** (integer (int64))
            - **name** (string)
            - **internalName** (string)
        - **feedbackDate** (string (date-time))
        - **priceOpinion** (number (float))
        - **saleLifeId** (number (int64))
        - **leaseLifeId** (number (int64))
        - **contractRequested** (boolean)
        - **contractSent** (string (date-time))
    - **property** (object)
    - **user** (object)
      - **id** (integer (int64))
      - **name** (string)
      - **photo** (object)
      - **account** (object)
- **totalItems** (integer (int64))
- **totalPages** (integer (int64))
- **urls** (object)
  - **previous** (string)
  - **next** (string)
  - **self** (string)

### Example Usage

```bash
curl -X GET "https://ap-southeast-2.api.vaultre.com.au/api/v1.3/tasks?startingAfter=2023-01-01T00:00:00Z&startingBefore=2023-01-01T00:00:00Z&userid=0&completed=true&insertedSince=2023-01-01T00:00:00Z&insertedBefore=2023-01-01T00:00:00Z&page=0&pagesize=50&sort=start&sortOrder=asc"
```

```

--------------------------------

### GET /suppliers

Source: https://docs.api.vaultre.com.au/swagger/vaultre.yaml

Retrieve a list of suppliers

```markdown
### Parameters

- **page** (integer (int64), query, optional): Page number of results
- **pagesize** (integer (int64), query, optional): Number of records to be returned in each page.
- **modifiedSince** (string (date-time), query, optional): Filter results modified since this datetime
- **modifiedBefore** (string (date-time), query, optional): Filter results modified before this datetime
- **sort** (string (inserted|modified), query, optional): Field by which to sort the results.
- **sortOrder** (string (asc|desc), query, optional): Order by which to sort the results. Used in conjunction with sort parameter.

### Responses

#### 200 - Suppliers retrieved

- **items** (array (Supplier))
  Array items:
    - **id** (integer (int64))
    - **title** (string)
    - **firstName** (string)
    - **lastName** (string)
    - **greeting** (string)
    - **displayName** (string)
    - **partnerTitle** (string)
    - **partnerFirstName** (string)
    - **partnerLastName** (string)
    - **company** (string)
    - **position** (string)
    - **address** (object)
      - **level** (string)
      - **unitNumber** (string)
      - **streetNumber** (string)
      - **street** (string)
      - **suburb** (object)
        - **id** (integer (int64))
        - **name** (string)
        - **postcode** (string)
        - **state** (object)
          - **id** (integer (int64))
          - **name** (string)
          - **abbreviation** (string)
        - **nzDistrict** (object)
          - **id** (integer (int64))
          - **name** (string)
          - **region** (object)
            - **id** (integer (int64))
            - **name** (string)
        - **isPoBox** (boolean)
      - **state** (object)
      - **country** (object)
        - **id** (integer (int64))
        - **name** (string)
        - **isocode** (string)
        - **gstRate** (number (float))
      - **royalMail** (object)
        - **buildingName** (string)
        - **buildingNumber** (string)
        - **department** (string)
        - **locality** (string)
        - **locality2** (string)
        - **organisation** (string)
        - **postTown** (string)
        - **postcode** (string)
        - **subbuildingName** (string)
        - **subbuildingNumber** (string)
        - **thoroughfare** (string)
        - **thoroughfare2** (string)
        - **udprn** (integer (int64))
      - **customAddress** (object)
        - **address1** (string)
        - **address2** (string)
        - **postTown** (string)
        - **postcode** (string)
    - **postalAddress** (object)
    - **onDoNotCallList** (boolean)
    - **archived** (boolean)
    - **inserted** (string (date-time))
    - **modified** (string (date-time))
    - **touched** (string (date-time))
    - **remoteId** (string)
    - **unsubscribe** (object)
      - **email** (boolean)
      - **sms** (boolean)
      - **letters** (boolean)
    - **entityType** (object)
    - **emails** (array (string (email)))
    - **phoneNumbers** (array (PhoneNumber))
      Array items:
        - **number** (string)
        - **typeCode** (string (H|W|M|F|D)) ("H"|"W"|"M"|"F"|"D")
        - **type** (string (Home|Work|Mobile|Facsimile|Direct)) ("Home"|"Work"|"Mobile"|"Facsimile"|"Direct")
        - **comment** (string)
    - **legalDescription** (string)
    - **abn** (string): Australian Business Number (ABN). For New Zealand customers, this field represents the GST registration number.
    - **acn** (string): Australian Company Number (ACN).
    - **marketingUsers** (array (MarketingUser))
      Array items:
        - **id** (integer (int64))
        - **user** (object)
          - **id** (integer (int64))
          - **name** (string)
          - **photo** (object)
            - **original** (string)
            - **thumb_360** (string)
          - **account** (object)
    - **smsUnsubscribeUrl** (string)
    - **customUnsubscribe** (array (UnsubscribeType))
      Array items:
    - **labels** (array (string))
- **totalItems** (integer (int64))
- **totalPages** (integer (int64))
- **urls** (object)
  - **previous** (string)
  - **next** (string)
  - **self** (string)

### Example Usage

```bash
curl -X GET "https://ap-southeast-2.api.vaultre.com.au/api/v1.3/suppliers?page=0&pagesize=50&modifiedSince=2023-01-01T00:00:00Z&modifiedBefore=2023-01-01T00:00:00Z&sort=inserted&sortOrder=asc"
```

```

--------------------------------

### GET /invoices/saleSummary

Source: https://docs.api.vaultre.com.au/swagger/vaultre.yaml

API endpoint for GET /invoices/saleSummary

```markdown
### Parameters

- **includeMultiOffice** (boolean, query, optional): Include multi office sales
- **createdSince** (string (date-time), query, optional): Filter results since this datetime
- **createdBefore** (string (date-time), query, optional): Filter results before this datetime

### Responses

#### 200 - Sale Summary retrieved

- **items** (array (SaleSummary))
  Array items:
    - **account** (object)
      - **id** (integer (int64))
      - **name** (string)
    - **balance** (number (float))
    - **contractNumber** (string)
    - **created** (string (date-time))
    - **invoiceNumber** (string)
    - **invoiceToText** (string)
    - **saleLifeId** (integer (int64))
    - **totalFees** (number (float))
- **totalItems** (integer (int64))
- **totalPages** (integer (int64))
- **urls** (object)
  - **previous** (string)
  - **next** (string)
  - **self** (string)

### Example Usage

```bash
curl -X GET "https://ap-southeast-2.api.vaultre.com.au/api/v1.3/invoices/saleSummary?includeMultiOffice=true&createdSince=2023-01-01T00:00:00Z&createdBefore=2023-01-01T00:00:00Z"
```

```

--------------------------------

### POST /templates/ownerSummary

Source: https://docs.api.vaultre.com.au/swagger/vaultre.yaml

Create an Owner Summary template

```markdown
### Request Body

**Content-Type:** */*

- **name** (string)
- **subject** (string)
- **content** (string)
- **accessBy** (array (ID))
  Array items:
    - **id** (integer (int64))

### Responses

#### 201 - Owner Summary template created

**OwnerSummaryTemplate**
- **id** (integer (int64))
- **name** (string)
- **subject** (string)
- **content** (string)
- **accessBy** (array (Access))
  Array items:
    - **id** (integer (int64))
    - **name** (string)
    - **photo** (object)
      - **original** (string)
      - **thumb_360** (string)
    - **account** (object)
      - **id** (integer (int64))
      - **name** (string)
- **inserted** (string (date-time))

#### 400 - Invalid data

**SuccessOrError**
- **success** (boolean)
- **msg** (string)
- **code** (string)

### Example Usage

```bash
curl -X POST "https://ap-southeast-2.api.vaultre.com.au/api/v1.3/templates/ownerSummary" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "subject": "string",
  "content": "string",
  "accessBy": [
    "value"
  ]
}'
```

```

--------------------------------

### GET /integrator/usage

Source: https://docs.api.vaultre.com.au/swagger/vaultre.yaml

API endpoint for GET /integrator/usage

```markdown
### Responses

#### 200 - Usage retrieved

- **remaining** (integer (int64))
- **used** (integer (int64))

### Example Usage

```bash
curl -X GET "https://ap-southeast-2.api.vaultre.com.au/api/v1.3/integrator/usage"
```

```

--------------------------------

### POST /suppliers

Source: https://docs.api.vaultre.com.au/swagger/vaultre.yaml

Create a supplier

```markdown
### Request Body

**Content-Type:** */*

- **title** (string)
- **firstName** (string)
- **lastName** (string)
- **greeting** (string)
- **partnerTitle** (string)
- **partnerFirstName** (string)
- **partnerLastName** (string)
- **company** (string)
- **position** (string)
- **address** (object)
  - **level** (string)
  - **unitNumber** (string)
  - **streetNumber** (string)
  - **street** (string)
  - **suburb** (object)
    - **id** (integer (int64))
- **postalAddress** (object)
- **onDoNotCallList** (boolean)
- **unsubscribe** (object)
  - **email** (boolean)
  - **sms** (boolean)
  - **letters** (boolean)
- **emails** (array (string (email)))
- **phoneNumbers** (array (PhoneNumber))
  Array items:
    - **number** (string)
    - **typeCode** (string (H|W|M|F|D)) ("H"|"W"|"M"|"F"|"D")
    - **type** (string (Home|Work|Mobile|Facsimile|Direct)) ("Home"|"Work"|"Mobile"|"Facsimile"|"Direct")
    - **comment** (string)
- **legalDescription** (string)
- **abn** (string): Australian Business Number (ABN). For New Zealand customers, this field represents the GST registration number.
- **acn** (string): Australian Company Number (ACN).
- **accessBy** (array (ID))
  Array items:
- **sourceOfEnquiry** (object)
- **marketingUsers** (array (AddUpdateMarketingUser))
  Array items:
    - **id** (integer (int64))
    - **user** (object)
- **labels** (array (string))
- **inserted** (string (date-time))

### Responses

#### 201 - Supplier created

**SupplierExtended**
- **id** (integer (int64))
- **title** (string)
- **firstName** (string)
- **lastName** (string)
- **greeting** (string)
- **displayName** (string)
- **partnerTitle** (string)
- **partnerFirstName** (string)
- **partnerLastName** (string)
- **company** (string)
- **position** (string)
- **address** (object)
  - **level** (string)
  - **unitNumber** (string)
  - **streetNumber** (string)
  - **street** (string)
  - **suburb** (object)
    - **id** (integer (int64))
    - **name** (string)
    - **postcode** (string)
    - **state** (object)
      - **id** (integer (int64))
      - **name** (string)
      - **abbreviation** (string)
    - **nzDistrict** (object)
      - **id** (integer (int64))
      - **name** (string)
      - **region** (object)
        - **id** (integer (int64))
        - **name** (string)
    - **isPoBox** (boolean)
  - **state** (object)
  - **country** (object)
    - **id** (integer (int64))
    - **name** (string)
    - **isocode** (string)
    - **gstRate** (number (float))
  - **royalMail** (object)
    - **buildingName** (string)
    - **buildingNumber** (string)
    - **department** (string)
    - **locality** (string)
    - **locality2** (string)
    - **organisation** (string)
    - **postTown** (string)
    - **postcode** (string)
    - **subbuildingName** (string)
    - **subbuildingNumber** (string)
    - **thoroughfare** (string)
    - **thoroughfare2** (string)
    - **udprn** (integer (int64))
  - **customAddress** (object)
    - **address1** (string)
    - **address2** (string)
    - **postTown** (string)
    - **postcode** (string)
- **postalAddress** (object)
- **onDoNotCallList** (boolean)
- **archived** (boolean)
- **inserted** (string (date-time))
- **modified** (string (date-time))
- **touched** (string (date-time))
- **remoteId** (string)
- **unsubscribe** (object)
  - **email** (boolean)
  - **sms** (boolean)
  - **letters** (boolean)
- **entityType** (object)
- **emails** (array (string (email)))
- **phoneNumbers** (array (PhoneNumber))
  Array items:
    - **number** (string)
    - **typeCode** (string (H|W|M|F|D)) ("H"|"W"|"M"|"F"|"D")
    - **type** (string (Home|Work|Mobile|Facsimile|Direct)) ("Home"|"Work"|"Mobile"|"Facsimile"|"Direct")
    - **comment** (string)
- **legalDescription** (string)
- **abn** (string): Australian Business Number (ABN). For New Zealand customers, this field represents the GST registration number.
- **acn** (string): Australian Company Number (ACN).
- **marketingUsers** (array (MarketingUser))
  Array items:
    - **id** (integer (int64))
    - **user** (object)
      - **id** (integer (int64))
      - **name** (string)
      - **photo** (object)
        - **original** (string)
        - **thumb_360** (string)
      - **account** (object)
- **smsUnsubscribeUrl** (string)
- **customUnsubscribe** (array (UnsubscribeType))
  Array items:
- **accessBy** (array (Access))
  Array items:
- **sourceOfEnquiry** (object)
- **labels** (array (string))

#### 400 - Invalid data

**SuccessOrError**
- **success** (boolean)
- **msg** (string)
- **code** (string)

### Example Usage

```bash
curl -X POST "https://ap-southeast-2.api.vaultre.com.au/api/v1.3/suppliers" \
  -H "Content-Type: application/json" \
  -d '{
  "title": "string",
  "firstName": "string",
  "lastName": "string",
  "greeting": "string",
  "partnerTitle": "string",
  "partnerFirstName": "string",
  "partnerLastName": "string",
  "company": "string",
  "position": "string",
  "address": "value",
  "postalAddress": "value",
  "onDoNotCallList": "true",
  "unsubscribe": "value",
  "emails": [
    "user@example.com"
  ],
  "phoneNumbers": [
    "value"
  ],
  "legalDescription": "string",
  "abn": "string",
  "acn": "string",
  "accessBy": [
    "value"
  ],
  "sourceOfEnquiry": "value",
  "marketingUsers": [
    "value"
  ],
  "labels": [
    "string"
  ],
  "inserted": "2023-01-01T00:00:00Z"
}'
```

```

--------------------------------

### GET /templates/ownerSummary

Source: https://docs.api.vaultre.com.au/swagger/vaultre.yaml

Retrieve a list of owner summary templates

```markdown
### Parameters

- **page** (integer (int64), query, optional): Page number of results
- **pagesize** (integer (int64), query, optional): Number of records to be returned in each page.

### Responses

#### 200 - Owner Summary templates retrieved

- **items** (array (OwnerSummaryTemplate))
  Array items:
    - **id** (integer (int64))
    - **name** (string)
    - **subject** (string)
    - **content** (string)
    - **accessBy** (array (Access))
      Array items:
        - **id** (integer (int64))
        - **name** (string)
        - **photo** (object)
          - **original** (string)
          - **thumb_360** (string)
        - **account** (object)
          - **id** (integer (int64))
          - **name** (string)
    - **inserted** (string (date-time))
- **totalItems** (integer (int64))
- **totalPages** (integer (int64))
- **urls** (object)
  - **previous** (string)
  - **next** (string)
  - **self** (string)

### Example Usage

```bash
curl -X GET "https://ap-southeast-2.api.vaultre.com.au/api/v1.3/templates/ownerSummary?page=0&pagesize=50"
```

```

--------------------------------

### POST /buildings

Source: https://docs.api.vaultre.com.au/swagger/vaultre.yaml

Create a building record

```markdown
### Request Body

**Content-Type:** */*

- **name** (string)

### Responses

#### 200 - Building already exists

**Building**
- **id** (integer (int64))
- **name** (string)

#### 201 - Building created

**Building**
- **id** (integer (int64))
- **name** (string)

#### 400 - Invalid data

**SuccessOrError**
- **success** (boolean)
- **msg** (string)
- **code** (string)

### Example Usage

```bash
curl -X POST "https://ap-southeast-2.api.vaultre.com.au/api/v1.3/buildings" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string"
}'
```

```

--------------------------------

### GET /search/threads/staffTypes

Source: https://docs.api.vaultre.com.au/swagger/vaultre.yaml

Get all threads with the supplied recipients.

```markdown
### Parameters

- **staffTypes** (array (integer (int64)), query, optional): Staff Type ID
- **page** (integer (int64), query, optional): Page number of results
- **pagesize** (integer (int64), query, optional): Number of records to be returned in each page.
- **sort** (string (modified|created), query, optional): Field by which to sort the results.
- **sortOrder** (string (asc|desc), query, optional): Order by which to sort the results. Used in conjunction with sort parameter.

### Responses

#### 200 - Message threads retrieved


#### 400 - Invalid data

**SuccessOrError**
- **success** (boolean)
- **msg** (string)
- **code** (string)

### Example Usage

```bash
curl -X GET "https://ap-southeast-2.api.vaultre.com.au/api/v1.3/search/threads/staffTypes?staffTypes=item1,item2&page=0&pagesize=50&sort=modified&sortOrder=asc"
```

```

--------------------------------

### POST /tasks

Source: https://docs.api.vaultre.com.au/swagger/vaultre.yaml

Add a task

```markdown
### Request Body

**Content-Type:** application/json

- **subject** (string)
- **description** (string)
- **start** (string (date-time))
- **user** (object)
  - **id** (integer (int64))

### Responses

#### 201 - Task created

**Task**
- **id** (number (int64))
- **subject** (string)
- **description** (string)
- **inserted** (string (date-time))
- **completed** (boolean)
- **start** (string (date-time))
- **contact** (object)
  - **id** (integer (int64))
  - **name** (string)
- **contactNote** (object)
  - **id** (integer (int64))
  - **inserted** (string (date-time))
  - **modified** (string (date-time))
  - **body** (string)
  - **readOnly** (boolean)
  - **contact** (object)
    - **id** (integer (int64))
  - **insertedBy** (object)
    - **id** (integer (int64))
    - **firstName** (string)
    - **lastName** (string)
    - **username** (string)
    - **email** (string (email))
    - **adminAccess** (boolean)
    - **position** (string)
    - **role** (string (commercialSalesAndLeasing|residentialSales|propertyManagement)) ("commercialSalesAndLeasing"|"residentialSales"|"propertyManagement")
    - **photo** (object)
      - **original** (string)
      - **thumb_360** (string)
    - **lastLogin** (string (date-time))
    - **phoneNumbers** (array (PhoneNumber))
      Array items:
        - **number** (string)
        - **typeCode** (string (H|W|M|F|D)) ("H"|"W"|"M"|"F"|"D")
        - **type** (string (Home|Work|Mobile|Facsimile|Direct)) ("Home"|"Work"|"Mobile"|"Facsimile"|"Direct")
        - **comment** (string)
    - **profile** (string)
    - **permissions** (object)
      - **settings** (boolean)
      - **accessPropertyManagement** (boolean)
      - **accessSales** (boolean)
      - **canLogin** (boolean)
      - **deleteContacts** (boolean)
      - **deleteProperties** (boolean)
      - **globalActionListsReadWrite** (boolean)
      - **globalContactsReadWrite** (boolean)
      - **globalNotesRead** (boolean)
      - **globalNotesReadWrite** (boolean)
      - **globalPropertiesRead** (boolean)
      - **globalPropertiesReadWrite** (boolean)
      - **globalTasksReadWrite** (boolean)
      - **sendSMS** (boolean)
      - **accessPropertyFinancials** (boolean)
      - **accessAlarmDetails** (boolean)
      - **modifyWebsiteContent** (boolean)
      - **editMarketingContact** (boolean)
    - **websiteUrl** (string)
    - **showOnWeb** (boolean)
    - **externalReference** (string)
    - **ssoIdentifier** (string)
    - **signature** (string)
    - **account** (object)
    - **hideMobileFromPortal** (boolean)
  - **type** (object)
    - **id** (integer (int64))
    - **name** (string)
    - **colour** (string)
    - **defaultReadOnly** (boolean)
    - **pinned** (boolean)
    - **purpose** (object)
  - **reminder** (object)
    - **date** (string (date-time))
    - **user** (object)
  - **propertyFeedback** (object)
    - **id** (integer (int64))
    - **property** (object)
      - **id** (number (int64))
      - **displayAddress** (string)
      - **saleLifeId** (number (int64))
      - **leaseLifeId** (number (int64))
      - **class** (object)
        - **id** (integer (int64))
        - **name** (string)
        - **internalName** (string)
    - **feedbackDate** (string (date-time))
    - **priceOpinion** (number (float))
    - **saleLifeId** (number (int64))
    - **leaseLifeId** (number (int64))
    - **contractRequested** (boolean)
    - **contractSent** (string (date-time))
- **property** (object)
- **user** (object)
  - **id** (integer (int64))
  - **name** (string)
  - **photo** (object)
  - **account** (object)

#### 400 - Invalid data

**SuccessOrError**
- **success** (boolean)
- **msg** (string)
- **code** (string)

### Example Usage

```bash
curl -X POST "https://ap-southeast-2.api.vaultre.com.au/api/v1.3/tasks" \
  -H "Content-Type: application/json" \
  -d '{
  "subject": "string",
  "description": "string",
  "start": "2023-01-01T00:00:00Z",
  "user": "value"
}'
```

```

--------------------------------

### GET /tasks/{id}

Source: https://docs.api.vaultre.com.au/swagger/vaultre.yaml

Get a single task

```markdown
### Parameters

- **id** (integer (int64), path, required): The ID of the task

### Responses

#### 200 - Task retrieved

**Task**
- **id** (number (int64))
- **subject** (string)
- **description** (string)
- **inserted** (string (date-time))
- **completed** (boolean)
- **start** (string (date-time))
- **contact** (object)
  - **id** (integer (int64))
  - **name** (string)
- **contactNote** (object)
  - **id** (integer (int64))
  - **inserted** (string (date-time))
  - **modified** (string (date-time))
  - **body** (string)
  - **readOnly** (boolean)
  - **contact** (object)
    - **id** (integer (int64))
  - **insertedBy** (object)
    - **id** (integer (int64))
    - **firstName** (string)
    - **lastName** (string)
    - **username** (string)
    - **email** (string (email))
    - **adminAccess** (boolean)
    - **position** (string)
    - **role** (string (commercialSalesAndLeasing|residentialSales|propertyManagement)) ("commercialSalesAndLeasing"|"residentialSales"|"propertyManagement")
    - **photo** (object)
      - **original** (string)
      - **thumb_360** (string)
    - **lastLogin** (string (date-time))
    - **phoneNumbers** (array (PhoneNumber))
      Array items:
        - **number** (string)
        - **typeCode** (string (H|W|M|F|D)) ("H"|"W"|"M"|"F"|"D")
        - **type** (string (Home|Work|Mobile|Facsimile|Direct)) ("Home"|"Work"|"Mobile"|"Facsimile"|"Direct")
        - **comment** (string)
    - **profile** (string)
    - **permissions** (object)
      - **settings** (boolean)
      - **accessPropertyManagement** (boolean)
      - **accessSales** (boolean)
      - **canLogin** (boolean)
      - **deleteContacts** (boolean)
      - **deleteProperties** (boolean)
      - **globalActionListsReadWrite** (boolean)
      - **globalContactsReadWrite** (boolean)
      - **globalNotesRead** (boolean)
      - **globalNotesReadWrite** (boolean)
      - **globalPropertiesRead** (boolean)
      - **globalPropertiesReadWrite** (boolean)
      - **globalTasksReadWrite** (boolean)
      - **sendSMS** (boolean)
      - **accessPropertyFinancials** (boolean)
      - **accessAlarmDetails** (boolean)
      - **modifyWebsiteContent** (boolean)
      - **editMarketingContact** (boolean)
    - **websiteUrl** (string)
    - **showOnWeb** (boolean)
    - **externalReference** (string)
    - **ssoIdentifier** (string)
    - **signature** (string)
    - **account** (object)
    - **hideMobileFromPortal** (boolean)
  - **type** (object)
    - **id** (integer (int64))
    - **name** (string)
    - **colour** (string)
    - **defaultReadOnly** (boolean)
    - **pinned** (boolean)
    - **purpose** (object)
  - **reminder** (object)
    - **date** (string (date-time))
    - **user** (object)
  - **propertyFeedback** (object)
    - **id** (integer (int64))
    - **property** (object)
      - **id** (number (int64))
      - **displayAddress** (string)
      - **saleLifeId** (number (int64))
      - **leaseLifeId** (number (int64))
      - **class** (object)
        - **id** (integer (int64))
        - **name** (string)
        - **internalName** (string)
    - **feedbackDate** (string (date-time))
    - **priceOpinion** (number (float))
    - **saleLifeId** (number (int64))
    - **leaseLifeId** (number (int64))
    - **contractRequested** (boolean)
    - **contractSent** (string (date-time))
- **property** (object)
- **user** (object)
  - **id** (integer (int64))
  - **name** (string)
  - **photo** (object)
  - **account** (object)

### Example Usage

```bash
curl -X GET "https://ap-southeast-2.api.vaultre.com.au/api/v1.3/tasks/{id}"
```

```