Download OpenAPI specification:Download
BreezeDoc's REST API provides a handful of endpoints which can be used to get information about your account and bookings. It uses conventional OAuth 2.0 protocol for authentication.
Create a personal access token at https://breezedoc.com/integrations/api. Once created, it can be used to authenticate requests by passing it in the Authorization
header.
Authorization: Bearer {TOKEN}
If you're building a custom integration to BreezeDoc which requires users to authenticate in order to get access tokens to make API requests on their behalf, you'll need to create an OAuth 2.0 client. This is easy to do from the "OAuth Apps" settings page found here https://breezedoc.com/integrations/api
Using the authorization_code
grant type to authenticate users using OAuth 2.0 to retrieve an access token is fairly conventional, more information on that process can be found here: https://www.oauth.com/oauth2-servers/server-side-apps/authorization-code/
The API currently has a rate limit of 60 requests per minute. If you exceed this limit, you will receive a 429 error.
order_by | string Value: "id" |
direction | string Enum: "asc" "desc" |
{- "current_page": 0,
- "data": [
- {
- "id": 0,
- "document_files": [
- {
- "id": 0,
- "document_file_pages": [ ]
}
], - "fields": [
- {
- "id": 0,
- "recipient_field": { }
}
], - "recipients": [
- {
- "id": 0,
- "slug": "string",
- "email": "user@example.com",
- "recipient_fields": { },
- "party": 0,
- "owner": true,
- "sent_at": "2019-08-24T14:15:22Z",
- "opened_at": "2019-08-24T14:15:22Z",
- "completed_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "title": "string",
- "slug": "string"
}
], - "first_page_url": "string",
- "from": 0,
- "last_page": 0,
- "last_page_url": "string",
- "next_page_url": "string",
- "path": "string",
- "per_page": 0,
- "prev_page_url": "string",
- "to": 0,
- "total": 0
}
title required | string <= 191 characters |
Array of objects |
{- "title": "string",
- "recipients": [
- {
- "email": "user@example.com",
- "name": "string",
- "party": 0
}
]
}
{- "id": 0,
- "document_files": [
- {
- "id": 0,
- "document_file_pages": [ ]
}
], - "fields": [
- {
- "id": 0,
- "recipient_field": { }
}
], - "recipients": [
- {
- "id": 0,
- "slug": "string",
- "email": "user@example.com",
- "recipient_fields": { },
- "party": 0,
- "owner": true,
- "sent_at": "2019-08-24T14:15:22Z",
- "opened_at": "2019-08-24T14:15:22Z",
- "completed_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "title": "string",
- "slug": "string"
}
{- "id": 0,
- "document_files": [
- {
- "id": 0,
- "document_file_pages": [ ]
}
], - "fields": [
- {
- "id": 0,
- "recipient_field": { }
}
], - "recipients": [
- {
- "id": 0,
- "slug": "string",
- "email": "user@example.com",
- "recipient_fields": { },
- "party": 0,
- "owner": true,
- "sent_at": "2019-08-24T14:15:22Z",
- "opened_at": "2019-08-24T14:15:22Z",
- "completed_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "title": "string",
- "slug": "string"
}
document required | integer |
required | Array of objects Array of recipients that must match the number of recipients on the document, provided in ascending order of party. |
{- "recipients": [
- {
- "name": "string",
- "email": "user@example.com"
}
]
}
{- "id": 0,
- "document_files": [
- {
- "id": 0,
- "document_file_pages": [ ]
}
], - "fields": [
- {
- "id": 0,
- "recipient_field": { }
}
], - "recipients": [
- {
- "id": 0,
- "slug": "string",
- "email": "user@example.com",
- "recipient_fields": { },
- "party": 0,
- "owner": true,
- "sent_at": "2019-08-24T14:15:22Z",
- "opened_at": "2019-08-24T14:15:22Z",
- "completed_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "title": "string",
- "slug": "string"
}
document required | integer |
order_by | string Enum: "completed_at" "id" |
direction | string Enum: "asc" "desc" |
completed | string Enum: true false |
{- "current_page": 0,
- "data": [
- {
- "id": 0,
- "slug": "string",
- "email": "user@example.com",
- "recipient_fields": { },
- "party": 0,
- "owner": true,
- "sent_at": "2019-08-24T14:15:22Z",
- "opened_at": "2019-08-24T14:15:22Z",
- "completed_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "first_page_url": "string",
- "from": 0,
- "last_page": 0,
- "last_page_url": "string",
- "next_page_url": "string",
- "path": "string",
- "per_page": 0,
- "prev_page_url": "string",
- "to": 0,
- "total": 0
}
document required | integer |
order_by | string Enum: "completed_at" "id" |
direction | string Enum: "asc" "desc" |
completed | string Enum: true false |
{- "current_page": 0,
- "data": [
- {
- "id": 0,
- "slug": "string",
- "email": "user@example.com",
- "recipient_fields": { },
- "party": 0,
- "owner": true,
- "sent_at": "2019-08-24T14:15:22Z",
- "opened_at": "2019-08-24T14:15:22Z",
- "completed_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "first_page_url": "string",
- "from": 0,
- "last_page": 0,
- "last_page_url": "string",
- "next_page_url": "string",
- "path": "string",
- "per_page": 0,
- "prev_page_url": "string",
- "to": 0,
- "total": 0
}
order_by | string Enum: "completed_at" "id" |
direction | string Enum: "asc" "desc" |
{- "current_page": 0,
- "data": [
- {
- "id": 0,
- "slug": "string",
- "email": "user@example.com",
- "recipient_fields": { },
- "party": 0,
- "owner": true,
- "sent_at": "2019-08-24T14:15:22Z",
- "opened_at": "2019-08-24T14:15:22Z",
- "completed_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "first_page_url": "string",
- "from": 0,
- "last_page": 0,
- "last_page_url": "string",
- "next_page_url": "string",
- "path": "string",
- "per_page": 0,
- "prev_page_url": "string",
- "to": 0,
- "total": 0
}
{- "current_page": 0,
- "data": [
- {
- "id": 0,
- "document_files": [
- {
- "id": 0,
- "document_file_pages": [ ]
}
], - "fields": [
- {
- "id": 0,
- "recipient_field": { }
}
], - "recipients": [
- {
- "id": 0,
- "slug": "string",
- "email": "user@example.com",
- "recipient_fields": { },
- "party": 0,
- "owner": true,
- "sent_at": "2019-08-24T14:15:22Z",
- "opened_at": "2019-08-24T14:15:22Z",
- "completed_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "title": "string",
- "slug": "string",
- "is_template": true
}
], - "first_page_url": "string",
- "from": 0,
- "last_page": 0,
- "last_page_url": "string",
- "next_page_url": "string",
- "path": "string",
- "per_page": 0,
- "prev_page_url": "string",
- "to": 0,
- "total": 0
}
{- "id": 0,
- "document_files": [
- {
- "id": 0,
- "document_file_pages": [ ]
}
], - "fields": [
- {
- "id": 0,
- "recipient_field": { }
}
], - "recipients": [
- {
- "id": 0,
- "slug": "string",
- "email": "user@example.com",
- "recipient_fields": { },
- "party": 0,
- "owner": true,
- "sent_at": "2019-08-24T14:15:22Z",
- "opened_at": "2019-08-24T14:15:22Z",
- "completed_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "title": "string",
- "slug": "string",
- "is_template": true
}
template required | integer |
{- "id": 0,
- "document_files": [
- {
- "id": 0,
- "document_file_pages": [ ]
}
], - "fields": [
- {
- "id": 0,
- "recipient_field": { }
}
], - "recipients": [
- {
- "id": 0,
- "slug": "string",
- "email": "user@example.com",
- "recipient_fields": { },
- "party": 0,
- "owner": true,
- "sent_at": "2019-08-24T14:15:22Z",
- "opened_at": "2019-08-24T14:15:22Z",
- "completed_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "title": "string",
- "slug": "string"
}