### List Properties using cURL

Source: https://developer.breezeway.io/reference/external-id-methods

This example shows how to retrieve a list of properties using a GET request. It requires an authorization token and specifies the 'accept' header for JSON responses. This is a fundamental operation for managing properties.

```Shell
curl --request GET \
  --url https://api.breezeway.io/public/inventory/v1/property \
  --header 'Authorization: JWT {{token}}' \
  --header 'accept: application/json'
```

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

### List Subdepartments using cURL

Source: https://developer.breezeway.io/reference/external-id-methods

This example shows how to retrieve a list of subdepartments using a GET request. It requires an authorization token and specifies the 'accept' header for JSON responses. This operation is part of the Company API.

```Shell
curl --request GET \
  --url https://api.breezeway.io/public/company/v1/subdepartment \
  --header 'Authorization: JWT {{token}}' \
  --header 'accept: application/json'
```

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

### List Available Supplies

Source: https://developer.breezeway.io/reference/approve-task

Retrieves a list of all available supplies. This is a GET request.

```HTTP
GET /supplies/available
```

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

### List Tasks using cURL

Source: https://developer.breezeway.io/reference/external-id-methods

This example shows how to retrieve a list of tasks using a GET request. It requires an authorization token and specifies the 'accept' header for JSON responses. This operation is part of the Task API.

```Shell
curl --request GET \
  --url https://api.breezeway.io/public/task/v1/task \
  --header 'Authorization: JWT {{token}}' \
  --header 'accept: application/json'
```

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

### List Companies using cURL

Source: https://developer.breezeway.io/reference/external-id-methods

This example shows how to retrieve a list of companies using a GET request. It requires an authorization token and specifies the 'accept' header for JSON responses. This operation is part of the Company API.

```Shell
curl --request GET \
  --url https://api.breezeway.io/public/company/v1/company \
  --header 'Authorization: JWT {{token}}' \
  --header 'accept: application/json'
```

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

### List Available Templates

Source: https://developer.breezeway.io/reference/approve-task

Retrieves a list of all available templates. This is a GET request.

```HTTP
GET /templates/available
```

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

### List Properties

Source: https://developer.breezeway.io/reference/approve-task

Retrieves a list of all properties. This is a GET request.

```HTTP
GET /properties
```

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

### List Tasks

Source: https://developer.breezeway.io/reference/approve-task

Retrieves a list of all tasks. This is a GET request.

```HTTP
GET /tasks
```

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

### List Available Templates

Source: https://developer.breezeway.io/reference

Provides the GET method to retrieve a list of all available templates within the system.

```HTTP
GET /templates
```

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

### Supply API: List Available Supplies

Source: https://developer.breezeway.io/reference/people

Retrieve a list of all available supplies. This is a GET request.

```bash
GET /v1/supplies
```

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

### List Available Property Tags

Source: https://developer.breezeway.io/reference/approve-task

Retrieves a list of all available tags that can be applied to properties. This is a GET request.

```HTTP
GET /property-tags/available
```

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

### List Companies

Source: https://developer.breezeway.io/reference/approve-task

Retrieves a list of all companies. This is a GET request.

```HTTP
GET /companies
```

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

### Company API: List Available Templates

Source: https://developer.breezeway.io/reference/people

Retrieve a list of all available templates for companies. This is a GET request.

```bash
GET /v1/company_templates
```

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

### List Subdepartments

Source: https://developer.breezeway.io/reference/approve-task

Retrieves a list of all subdepartments. This is a GET request.

```HTTP
GET /subdepartments
```

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

### List Available Supplies (GET)

Source: https://developer.breezeway.io/reference/property-photos

This endpoint retrieves a list of available supplies. It is part of the Supply API.

```HTTP
GET /supplies/available
```

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

### List Available Task Tags

Source: https://developer.breezeway.io/reference/approve-task

Retrieves a list of all available tags that can be applied to tasks. This is a GET request.

```HTTP
GET /task-tags/available
```

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

### List Available Templates (GET)

Source: https://developer.breezeway.io/reference/property-photos

This endpoint retrieves a list of available templates. It is part of the Templates API.

```HTTP
GET /templates/available
```

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

### Property API: List Properties

Source: https://developer.breezeway.io/reference/people

Retrieve a list of all properties. This is a GET request.

```bash
GET /v1/properties
```

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

### List Available Property Tags (Shell)

Source: https://developer.breezeway.io/reference/add-tags-for-property

This example shows how to list all available tags that can be applied to a property using a shell command. It targets the Breezeway API endpoint for listing property tags.

```Shell
curl --request GET \
     --url https://api.breezeway.io/public/inventory/v1/property/tags \
     --header 'Authorization: JWT {{token}}'
```

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

### Get Task Tags using cURL

Source: https://developer.breezeway.io/reference/external-id-methods

This example shows how to retrieve tags associated with a task using a GET request. It requires an authorization token and specifies the 'accept' header for JSON responses. This operation is part of the Task API.

```Shell
curl --request GET \
  --url https://api.breezeway.io/public/task/v1/tag?task_id={id} \
  --header 'Authorization: JWT {{token}}' \
  --header 'accept: application/json'
```

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

### Authenticate API Request (cURL)

Source: https://developer.breezeway.io/docs/authentication

This snippet demonstrates how to authenticate a GET request to the Breezeway platform API by including the JWT access token in the Authorization header with the 'JWT' scheme prefix.

```cURL
curl --request GET \
     --url https://api.breezeway.io/public/inventory/v1/property \
     --header 'Authorization: JWT <YOUR_ACCESS_TOKEN>' \
     --header 'accept: application/json'
```

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

### Create a New Task

Source: https://developer.breezeway.io/reference

Outlines the POST method for creating a new task. Requires task details as input.

```HTTP
POST /tasks
```

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

### Create a New Property

Source: https://developer.breezeway.io/reference

Outlines the POST method for creating a new property entry in the system. Requires property details as input.

```HTTP
POST /properties
```

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

### List Available Reservation Tags

Source: https://developer.breezeway.io/reference/approve-task

Retrieves a list of all available tags that can be applied to reservations. This is a GET request.

```HTTP
GET /reservation-tags/available
```

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

### List Supplies (cURL)

Source: https://developer.breezeway.io/reference/list-available-supplies

This snippet demonstrates how to list supplies using a cURL request to the Breezeway API. It includes authorization headers and specifies parameters for limiting results and sorting.

```shell
curl --request GET \
     --url 'https://api.breezeway.io/public/inventory/v1/supplies?limit=100&page=1&sort_by=created_at&sort_order=desc' \
     --header 'Authorization: JWT {{token}}' \
     --header 'accept: application/json'
```

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

### List People using cURL

Source: https://developer.breezeway.io/reference/external-id-methods

This example shows how to retrieve a list of people using a GET request. It requires an authorization token and specifies the 'accept' header for JSON responses. This operation is part of the People API.

```Shell
curl --request GET \
  --url https://api.breezeway.io/public/people/v1/person \
  --header 'Authorization: JWT {{token}}' \
  --header 'accept: application/json'
```

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

### List Reservations

Source: https://developer.breezeway.io/reference

Provides the GET method to retrieve a list of all reservations. Useful for overview and management.

```HTTP
GET /reservations
```

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

### Create a Webhook Subscription

Source: https://developer.breezeway.io/reference

Outlines the POST method for creating a new webhook subscription. Requires subscription details.

```HTTP
POST /subscriptions
```

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

### Retrieve Task Comments using cURL

Source: https://developer.breezeway.io/reference/external-id-methods

This example shows how to retrieve comments for a task using a GET request. It requires an authorization token and specifies the 'accept' header for JSON responses. This operation is part of the Task API.

```Shell
curl --request GET \
  --url https://api.breezeway.io/public/task/v1/comment?task_id={id} \
  --header 'Authorization: JWT {{token}}' \
  --header 'accept: application/json'
```

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

### Create a Reservation Tag

Source: https://developer.breezeway.io/reference

Outlines the POST method for creating a new tag that can be applied to reservations.

```HTTP
POST /reservation-tags
```

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

### Retrieve Reservation using cURL

Source: https://developer.breezeway.io/reference/external-id-methods

This example shows how to retrieve details for a specific reservation using a GET request. It requires an authorization token and specifies the 'accept' header for JSON responses. This operation is part of the Reservation API.

```Shell
curl --request GET \
  --url https://api.breezeway.io/public/reservation/v1/reservation/{id} \
  --header 'Authorization: JWT {{token}}' \
  --header 'accept: application/json'
```

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

### Create a New Reservation

Source: https://developer.breezeway.io/reference

Outlines the POST method for creating a new reservation. Requires reservation details as input.

```HTTP
POST /reservations
```

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

### List Supplies (cURL)

Source: https://developer.breezeway.io/reference/supplies

This snippet demonstrates how to list supplies using a cURL request to the Breezeway API. It includes authorization headers and specifies parameters for limiting results and sorting.

```shell
curl --request GET \
     --url 'https://api.breezeway.io/public/inventory/v1/supplies?limit=100&page=1&sort_by=created_at&sort_order=desc' \
     --header 'Authorization: JWT {{token}}' \
     --header 'accept: application/json'
```

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

### Retrieve Reservation Tags using cURL

Source: https://developer.breezeway.io/reference/external-id-methods

This example shows how to retrieve tags associated with a reservation using a GET request. It requires an authorization token and specifies the 'accept' header for JSON responses. This operation is part of the Reservation API.

```Shell
curl --request GET \
  --url https://api.breezeway.io/public/reservation/v1/tag?reservation_id={id} \
  --header 'Authorization: JWT {{token}}' \
  --header 'accept: application/json'
```

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

### Retrieve Tasks Linked to Reservation using cURL

Source: https://developer.breezeway.io/reference/external-id-methods

This example shows how to retrieve tasks linked to a reservation using a GET request. It requires an authorization token and specifies the 'accept' header for JSON responses. This operation is part of the Reservation API.

```Shell
curl --request GET \
  --url https://api.breezeway.io/public/reservation/v1/task?reservation_id={id} \
  --header 'Authorization: JWT {{token}}' \
  --header 'accept: application/json'
```

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

### Task API: Create Task

Source: https://developer.breezeway.io/reference/companies

Create a new task entry. This POST request requires task details such as description, assignee, and due date.

```HTTP
POST /tasks
```

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

### List Properties (GET)

Source: https://developer.breezeway.io/reference/properties

Retrieves a list of properties from the Breezeway API. Supports pagination and sorting. Requires authentication.

```HTTP
GET https://api.breezeway.io/public/inventory/v1/property
```

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

### List Available Supplies using cURL

Source: https://developer.breezeway.io/reference/external-id-methods

This snippet demonstrates how to retrieve a list of available supplies using a GET request. It requires an authorization token and specifies the 'accept' header for JSON responses. This operation is part of the Supply API.

```Shell
curl --request GET \
  --url https://api.breezeway.io/public/supply/v1/supply \
  --header 'Authorization: JWT {{token}}' \
  --header 'accept: application/json'
```

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

### List Property Contacts using cURL

Source: https://developer.breezeway.io/reference/external-id-methods

This example shows how to retrieve a list of contacts associated with a property using a GET request. It requires an authorization token and specifies the 'accept' header for JSON responses. This operation is part of the Property API.

```Shell
curl --request GET \
  --url https://api.breezeway.io/public/inventory/v1/property/contact?property_id={id} \
  --header 'Authorization: JWT {{token}}' \
  --header 'accept: application/json'
```

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

### Task API: Retrieve Task Requirements

Source: https://developer.breezeway.io/reference/people

Get the requirements for a specific task. This is a GET request.

```bash
GET /v1/tasks/{task_id}/requirements
```

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

### Get Tags for Task

Source: https://developer.breezeway.io/reference/approve-task

Fetches the tags associated with a specific task. This is a GET request.

```HTTP
GET /tasks/{taskId}/tags
```

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

### People API: Retrieve Person

Source: https://developer.breezeway.io/reference/people

Get details for a specific person using their ID. This is a GET request.

```bash
GET /v1/people/{person_id}
```

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

### Create Reservation - POST

Source: https://developer.breezeway.io/reference/create-reservation

Creates a new reservation in the Breezeway system. Requires property ID, reference reservation ID, and company ID. Optional parameters include dates, times, guest information, access codes, and tags.

```HTTP
POST https://api.breezeway.io/public/inventory/v1/reservation
```

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

### Task API: Get Tags for Task

Source: https://developer.breezeway.io/reference/people

Retrieve all tags associated with a specific task. This is a GET request.

```bash
GET /v1/tasks/{task_id}/tags
```

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

### Create Task

Source: https://developer.breezeway.io/reference/approve-task

Creates a new task. This is a POST request.

```HTTP
POST /tasks
```

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

### Task API: Retrieve Task Comments

Source: https://developer.breezeway.io/reference/people

Get comments associated with a specific task. This is a GET request.

```bash
GET /v1/tasks/{task_id}/comments
```

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

### Task API: Retrieve Task

Source: https://developer.breezeway.io/reference/people

Get details for a specific task using its ID. This is a GET request.

```bash
GET /v1/tasks/{task_id}
```

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

### List Available Supplies

Source: https://developer.breezeway.io/reference

Provides the GET method to retrieve a list of all available supplies. Useful for inventory management.

```HTTP
GET /supplies
```

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

### Create Task - cURL

Source: https://developer.breezeway.io/reference/create-task

This example demonstrates how to create a task using the Breezeway API via a cURL request. It includes setting the authorization token, content type, and request body with task details.

```Shell
curl --request POST \
     --url https://api.breezeway.io/public/inventory/v1/task \
     --header 'Authorization: JWT {{token}}' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
  "rate_type": "piece",
  "assign_default_workers": false
}'
```

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

### Reservation API: Retrieve Tags for Reservation

Source: https://developer.breezeway.io/reference/people

Get all tags associated with a specific reservation. This is a GET request.

```bash
GET /v1/reservations/{reservation_id}/tags
```

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

### Reservation API: Retrieve Reservation

Source: https://developer.breezeway.io/reference/people

Get details for a specific reservation using its ID. This is a GET request.

```bash
GET /v1/reservations/{reservation_id}
```

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

### List Available Templates using cURL

Source: https://developer.breezeway.io/reference/external-id-methods

This snippet demonstrates how to retrieve a list of available templates using a GET request. It requires an authorization token and specifies the 'accept' header for JSON responses. This operation is part of the Company API.

```Shell
curl --request GET \
  --url https://api.breezeway.io/public/company/v1/template \
  --header 'Authorization: JWT {{token}}' \
  --header 'accept: application/json'
```

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

### Create Property

Source: https://developer.breezeway.io/reference/approve-task

Creates a new property. This is a POST request.

```HTTP
POST /properties
```

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

### Property API: Retrieve Property Contact

Source: https://developer.breezeway.io/reference/people

Get details for a specific contact of a property. This is a GET request.

```bash
GET /v1/properties/{property_id}/contacts/{contact_id}
```

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

### Reservation API: Retrieve Tasks Linked to Reservation

Source: https://developer.breezeway.io/reference/people

Get a list of tasks associated with a reservation. This is a GET request.

```bash
GET /v1/reservations/{reservation_id}/tasks
```

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

### Property API: Create Property

Source: https://developer.breezeway.io/reference/companies

Create a new property entry in the system. This POST request requires property details in the request body.

```HTTP
POST /properties
```

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

### Get Tags for Task (GET)

Source: https://developer.breezeway.io/reference/property-photos

This endpoint retrieves the tags associated with a specific task. It is part of the Task Tags API.

```HTTP
GET /tasks/{task_id}/tags
```

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

### List Available Reservation Tags (cURL)

Source: https://developer.breezeway.io/reference/create-reservation-tag

This snippet demonstrates how to list available reservation tags using a cURL request. It includes the necessary endpoint, authentication header, and content type.

```Shell
curl --request POST \
     --url https://api.breezeway.io/public/inventory/v1/reservation/tags \
     --header 'Authorization: JWT {{token}}' \
     --header 'accept: application/json' \
     --header 'content-type: application/json'
```

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

### Get Tags for a Task

Source: https://developer.breezeway.io/reference

Details the GET method for fetching tags associated with a specific task. Requires the task ID.

```HTTP
GET /tasks/{taskId}/tags
```

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

### Task API: Get Tags for Task

Source: https://developer.breezeway.io/reference/companies

Fetch all tags associated with a specific task. This GET request requires the task ID.

```HTTP
GET /tasks/{taskId}/tags
```

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

### Create Reservation

Source: https://developer.breezeway.io/reference/approve-task

Creates a new reservation. This is a POST request.

```HTTP
POST /reservations
```

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

### Create Webhook Subscription

Source: https://developer.breezeway.io/reference/approve-task

Creates a new webhook subscription. This is a POST request.

```HTTP
POST /subscriptions
```

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

### List Reservations

Source: https://developer.breezeway.io/reference/approve-task

Retrieves a list of all reservations. This is a GET request.

```HTTP
GET /reservations
```

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

### List Reservations

Source: https://developer.breezeway.io/reference/reservations

Retrieves a list of reservations. This is a GET request to the specified endpoint.

```HTTP
GET https://api.breezeway.io/public/inventory/v1/reservation
```

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

### Create Reservation - Python

Source: https://developer.breezeway.io/reference/create-reservation

Example of creating a reservation using Python with the 'requests' library. This request requires an Authorization header with a JWT token and specifies the reservation type and stay type in the JSON body.

```python
import requests
import json

url = 'https://api.breezeway.io/public/inventory/v1/reservation'
token = 'YOUR_JWT_TOKEN'

headers = {
    'Authorization': f'JWT {token}',
    'accept': 'application/json',
    'content-type': 'application/json'
}

payload = {
    'type_stay': 'guest',
    'type_reservation': 'booking'
}

response = requests.post(url, headers=headers, data=json.dumps(payload))

print(response.json())
```

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

### Company API: List Companies

Source: https://developer.breezeway.io/reference/people

Retrieve a list of all companies. This is a GET request.

```bash
GET /v1/companies
```

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

### Obtain Access Token (Ruby)

Source: https://developer.breezeway.io/reference

This Ruby snippet illustrates how to obtain an access token using the Net::HTTP library. It sends a POST request to the Breezeway API's authentication endpoint.

```ruby
require 'net/http'
require 'uri'

uri = URI.parse('https://api.breezeway.io/public/auth/v1/')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Post.new(uri.request_uri)
response = http.request(request)

```

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

### Create Reservation - Node.js

Source: https://developer.breezeway.io/reference/create-reservation

Example of creating a reservation using Node.js with the 'axios' library. This request requires an Authorization header with a JWT token and specifies the reservation type and stay type in the JSON body.

```javascript
const axios = require('axios');

const createReservation = async (token) => {
  try {
    const response = await axios.post('https://api.breezeway.io/public/inventory/v1/reservation', {
      type_stay: 'guest',
      type_reservation: 'booking'
    }, {
      headers: {
        'Authorization': `JWT ${token}`,
        'accept': 'application/json',
        'content-type': 'application/json'
      }
    });
    return response.data;
  } catch (error) {
    console.error('Error creating reservation:', error);
    throw error;
  }
};

// Example usage:
// createReservation('YOUR_JWT_TOKEN').then(data => console.log(data));
```

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

### People API: List People

Source: https://developer.breezeway.io/reference/people

Retrieve a list of all people. This is a GET request.

```bash
GET /v1/people
```

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

### Company API: List Available Templates

Source: https://developer.breezeway.io/reference/companies

Retrieve a list of available templates that can be used within the company context. This is a GET request.

```HTTP
GET /company-templates
```

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

### Task API: List Tasks

Source: https://developer.breezeway.io/reference/people

Retrieve a list of all tasks. This is a GET request.

```bash
GET /v1/tasks
```

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

### Reservation API: List Reservations

Source: https://developer.breezeway.io/reference/people

Retrieve a list of all reservations. This is a GET request.

```bash
GET /v1/reservations
```

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

### Create Subscription using cURL

Source: https://developer.breezeway.io/reference/external-id-methods

This example shows how to create a webhook subscription using a POST request. It requires an authorization token and specifies the content type as JSON. This operation is part of the Webhook Subscription API.

```Shell
curl --request POST \
  --url https://api.breezeway.io/public/webhook/v1/subscription \
  --header 'Authorization: JWT {{token}}' \
  --header 'content-type: application/json' \
  --data '{ 
  "event": "property.created",
  "callback_url": "https://example.com/webhook"
}'
```

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

### Create Reservation Tag (Node.js)

Source: https://developer.breezeway.io/reference/retrieve-tags-for-reservation

This Node.js example shows how to create a tag for a reservation. It involves making a POST request to the Breezeway API with the reservation ID and tag details in the request body.

```Node
const axios = require('axios');

const createReservationTag = async (reservationId, tagData, token) => {
  try {
    const response = await axios.post('https://api.breezeway.io/public/inventory/v1/reservation/id/tags', {
      reservationId: reservationId,
      tags: tagData
    }, {
      headers: {
        'Authorization': `JWT ${token}`,
        'accept': 'application/json'
      }
    });
    return response.data;
  } catch (error) {
    console.error('Error creating reservation tag:', error);
    throw error;
  }
};

// Example usage:
// createReservationTag('some_reservation_id', ['tag1', 'tag2'], 'your_jwt_token');
```

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

### List Reservations

Source: https://developer.breezeway.io/reference/list-reservations

Retrieves a list of reservations. This is a GET request to the specified endpoint.

```HTTP
GET https://api.breezeway.io/public/inventory/v1/reservation
```

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

### List People

Source: https://developer.breezeway.io/reference/approve-task

Retrieves a list of all people in the system. This is a GET request.

```HTTP
GET /people
```

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

### Reservation API: Create Reservation

Source: https://developer.breezeway.io/reference/companies

Create a new reservation entry. This POST request requires reservation details such as dates, property, and guest information.

```HTTP
POST /reservations
```

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

### List Subdepartments (GET)

Source: https://developer.breezeway.io/reference/property-photos

This endpoint retrieves a list of subdepartments. It is part of the Subdepartments API.

```HTTP
GET /subdepartments
```

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

### Create Reservation - cURL

Source: https://developer.breezeway.io/reference/create-reservation

Example of creating a reservation using cURL. This request requires an Authorization header with a JWT token and specifies the reservation type and stay type in the JSON body.

```Shell
curl --request POST \
     --url https://api.breezeway.io/public/inventory/v1/reservation \
     --header 'Authorization: JWT {{token}}' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data \
'{ \
  "type_stay": "guest", \
  "type_reservation": "booking" \
}'
```

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

### List Companies (GET)

Source: https://developer.breezeway.io/reference/property-photos

This endpoint retrieves a list of companies. It is part of the Company API.

```HTTP
GET /companies
```

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

### List People (GET)

Source: https://developer.breezeway.io/reference/property-photos

This endpoint retrieves a list of people. It is part of the People API.

```HTTP
GET /people
```

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

### Create Reservation Tag

Source: https://developer.breezeway.io/reference/approve-task

Applies a tag to a specific reservation. This is a POST request.

```HTTP
POST /reservations/{reservationId}/tags
```

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

### List Tasks (GET)

Source: https://developer.breezeway.io/reference/property-photos

This endpoint retrieves a list of tasks. It is part of the Task API.

```HTTP
GET /tasks
```

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

### List Properties (cURL)

Source: https://developer.breezeway.io/reference/reservation-linked-tasks

This snippet demonstrates how to list all properties using a cURL request. It requires an Authorization header with a JWT token and specifies the content type as application/json.

```Shell
curl --request GET \
     --url https://api.breezeway.io/public/inventory/v1/property \
     --header 'Authorization: JWT {{token}}' \
     --header 'accept: application/json'
```