openapi: 3.0.4
info:
title: Mews Booking Engine API (Distributor) Account notes API
version: v1
description: The Mews Booking Engine API (historically the Distributor API, served from /api/distributor/v1) lets developers build guest-facing booking engines that create reservations directly in Mews. It exposes enterprise configuration, availability, pricing, products, vouchers, payment cards, and reservation group creation for front-end client consumption.
x-generated-from: documentation
x-source-url: https://api.mews.com/Swagger/distributor/swagger.json
x-last-validated: '2026-06-02'
servers:
- url: https://api.mews.com
description: Production
- url: https://api.mews-demo.com
description: Demo / sandbox
security:
- MewsClientToken: []
MewsAccessToken: []
tags:
- name: Account notes
paths:
/api/connector/v1/accountNotes/getAll:
post:
tags:
- Account notes
summary: Mews Get All Account Notes
description: 'Returns all account notes of an account, optionally filtered by activity state, account identifiers, specific account note identifiers or other filter parameters.
Note this operation uses [Pagination](https://mews-systems.gitbook.io/connector-api/guidelines/pagination/) and supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property).'
operationId: accountNotes_getAll
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AccountNoteFilterParameters'
example:
ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
Client: Sample Client 1.0.0
ChainIds:
- 1df21f06-0cfc-4960-9c58-a3bf1261663e
- 5fcd1933-22f2-40b9-84da-7db04cbecec2
AccountNoteIds:
- 3ed9e2f3-4bba-4df6-8d41-ab1b009b6425
- 8a98965a-7c03-48a1-a28c-ab1b009b53c8
AccountIds:
- a6738390-c241-45b7-8e46-14f47207abe5
- 435d4d5f-d14f-48dc-a47e-0481fc28ead0
UpdatedUtc:
StartUtc: '2022-10-10T00:00:00Z'
EndUtc: '2022-10-17T00:00:00Z'
ActivityStates:
- Active
Limitation:
Cursor: e7f26210-10e7-462e-9da8-ae8300be8ab7
Count: 100
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AccountNoteResult'
example:
AccountNotes:
- Id: a58ff7cb-77e3-495a-bd61-aecf00a3f19d
AccountId: 1df21f06-0cfc-4960-9c58-a3bf1261663e
Content: Customer receives a free bottle of champagne during stay
AccountType: Customer
Classifications:
- Gifts
IsActive: true
CreatorProfile:
Discriminator: Enterprise
EnterpriseProfile:
ProfileId: 52d19c34-b0aa-4635-905d-1326fa8b8e13
UpdaterProfile:
Discriminator: Integration
EnterpriseProfile: null
- Id: da34b396-41f7-47f6-8847-aecf00a3f19e
AccountId: 5fcd1933-22f2-40b9-84da-7db04cbecec2
Content: Lactose intolerant
AccountType: Customer
Classifications:
- FoodAndBeverage
IsActive: true
CreatorProfile:
Discriminator: Enterprise
EnterpriseProfile:
ProfileId: 52d19c34-b0aa-4635-905d-1326fa8b8e13
UpdaterProfile:
Discriminator: Integration
EnterpriseProfile: null
Cursor: da34b396-41f7-47f6-8847-aecf00a3f19e
'400':
description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
examples:
AccountNotesGetAll400Example:
summary: Default accountNotes_getAll 400 response
x-microcks-default: true
value:
Message: string
RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
Details: string
'401':
description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
examples:
AccountNotesGetAll401Example:
summary: Default accountNotes_getAll 401 response
x-microcks-default: true
value:
Message: string
RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
Details: string
'403':
description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
examples:
AccountNotesGetAll403Example:
summary: Default accountNotes_getAll 403 response
x-microcks-default: true
value:
Message: string
RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
Details: string
'408':
description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
examples:
AccountNotesGetAll408Example:
summary: Default accountNotes_getAll 408 response
x-microcks-default: true
value:
Message: string
RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
Details: string
'204':
description: Server has successfully fulfilled the request and there is no additional information to send back.
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
examples:
AccountNotesGetAll204Example:
summary: Default accountNotes_getAll 204 response
x-microcks-default: true
value:
Message: string
RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
Details: string
'429':
description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
examples:
AccountNotesGetAll429Example:
summary: Default accountNotes_getAll 429 response
x-microcks-default: true
value:
Message: string
RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
Details: string
'500':
description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api).
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
examples:
AccountNotesGetAll500Example:
summary: Default accountNotes_getAll 500 response
x-microcks-default: true
value:
Message: string
RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
Details: string
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/connector/v1/accountNotes/add:
post:
tags:
- Account notes
summary: Mews Add Account Notes
description: Adds account notes to an account of the enterprise chain. Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property).
operationId: accountNotes_add
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MultipleAccountNoteAddParameters'
example:
ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
Client: Sample Client 1.0.0
ChainId: 1df21f06-0cfc-4960-9c58-a3bf1261663e
AccountNotes:
- AccountId: 8ddea57b-6a5c-4eec-8c4c-24467dce118e
Content: Brother of the CEO
Classifications:
- FamilyRelations
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AccountNoteAdditionResult'
example:
AccountNotes:
- Id: a58ff7cb-77e3-495a-bd61-aecf00a3f19d
AccountId: 1df21f06-0cfc-4960-9c58-a3bf1261663e
Content: Brother of the CEO
AccountType: Customer
Classifications:
- FamilyRelations
IsActive: true
CreatorProfile:
Discriminator: Enterprise
EnterpriseProfile:
ProfileId: 52d19c34-b0aa-4635-905d-1326fa8b8e13
UpdaterProfile:
Discriminator: Integration
EnterpriseProfile: null
'400':
description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
examples:
AccountNotesAdd400Example:
summary: Default accountNotes_add 400 response
x-microcks-default: true
value:
Message: string
RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
Details: string
'401':
description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
examples:
AccountNotesAdd401Example:
summary: Default accountNotes_add 401 response
x-microcks-default: true
value:
Message: string
RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
Details: string
'403':
description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
examples:
AccountNotesAdd403Example:
summary: Default accountNotes_add 403 response
x-microcks-default: true
value:
Message: string
RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
Details: string
'408':
description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
examples:
AccountNotesAdd408Example:
summary: Default accountNotes_add 408 response
x-microcks-default: true
value:
Message: string
RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
Details: string
'204':
description: Server has successfully fulfilled the request and there is no additional information to send back.
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
examples:
AccountNotesAdd204Example:
summary: Default accountNotes_add 204 response
x-microcks-default: true
value:
Message: string
RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
Details: string
'429':
description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
examples:
AccountNotesAdd429Example:
summary: Default accountNotes_add 429 response
x-microcks-default: true
value:
Message: string
RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
Details: string
'500':
description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api).
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
examples:
AccountNotesAdd500Example:
summary: Default accountNotes_add 500 response
x-microcks-default: true
value:
Message: string
RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
Details: string
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/connector/v1/accountNotes/update:
post:
tags:
- Account notes
summary: Mews Update Account Notes
description: Updates information about the specified account notes.
operationId: accountNotes_update
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MultipleAccountNoteUpdateParameters'
example:
ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
Client: Sample Client 1.0.0
AccountNoteUpdates:
- AccountNoteId: a58ff7cb-77e3-495a-bd61-aecf00a3f19d
Content:
Value: The AC in the room doesn't work anymore
Classifications:
Maintenance:
Value: true
Housekeeping:
Value: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AccountNoteUpdateResult'
example:
AccountNotes:
- Id: a58ff7cb-77e3-495a-bd61-aecf00a3f19d
AccountId: 1df21f06-0cfc-4960-9c58-a3bf1261663e
Content: The AC in the room doesn't work anymore
AccountType: Customer
Classifications:
- Maintenance
IsActive: true
CreatorProfile:
Discriminator: Enterprise
EnterpriseProfile:
ProfileId: 52d19c34-b0aa-4635-905d-1326fa8b8e13
UpdaterProfile:
Discriminator: Integration
EnterpriseProfile: null
'400':
description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
examples:
AccountNotesUpdate400Example:
summary: Default accountNotes_update 400 response
x-microcks-default: true
value:
Message: string
RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
Details: string
'401':
description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
examples:
AccountNotesUpdate401Example:
summary: Default accountNotes_update 401 response
x-microcks-default: true
value:
Message: string
RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
Details: string
'403':
description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
examples:
AccountNotesUpdate403Example:
summary: Default accountNotes_update 403 response
x-microcks-default: true
value:
Message: string
RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
Details: string
'408':
description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
examples:
AccountNotesUpdate408Example:
summary: Default accountNotes_update 408 response
x-microcks-default: true
value:
Message: string
RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
Details: string
'204':
description: Server has successfully fulfilled the request and there is no additional information to send back.
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
examples:
AccountNotesUpdate204Example:
summary: Default accountNotes_update 204 response
x-microcks-default: true
value:
Message: string
RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
Details: string
'429':
description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
examples:
AccountNotesUpdate429Example:
summary: Default accountNotes_update 429 response
x-microcks-default: true
value:
Message: string
RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
Details: string
'500':
description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api).
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
examples:
AccountNotesUpdate500Example:
summary: Default accountNotes_update 500 response
x-microcks-default: true
value:
Message: string
RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
Details: string
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/connector/v1/accountNotes/delete:
post:
tags:
- Account notes
summary: Mews Delete Account Notes
description: Deletes specified account notes.
operationId: accountNotes_delete
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MultipleAccountNoteDeleteParameters'
example:
ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
Client: Sample Client 1.0.0
AccountNoteIds:
- a58ff7cb-77e3-495a-bd61-aecf00a3f19d
- da34b396-41f7-47f6-8847-aecf00a3f19e
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Unit'
examples:
AccountNotesDelete200Example:
summary: Default accountNotes_delete 200 response
x-microcks-default: true
value: {}
'400':
description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
examples:
AccountNotesDelete400Example:
summary: Default accountNotes_delete 400 response
x-microcks-default: true
value:
Message: string
RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
Details: string
'401':
description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
examples:
AccountNotesDelete401Example:
summary: Default accountNotes_delete 401 response
x-microcks-default: true
value:
Message: string
RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
Details: string
'403':
description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
examples:
AccountNotesDelete403Example:
summary: Default accountNotes_delete 403 response
x-microcks-default: true
value:
Message: string
RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
Details: string
'408':
description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
examples:
AccountNotesDelete408Example:
summary: Default accountNotes_delete 408 response
x-microcks-default: true
value:
Message: string
RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
Details: string
'204':
description: Server has successfully fulfilled the request and there is no additional information to send back.
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
examples:
AccountNotesDelete204Example:
summary: Default accountNotes_delete 204 response
x-microcks-default: true
value:
Message: string
RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
Details: string
'429':
description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
examples:
AccountNotesDelete429Example:
summary: Default accountNotes_delete 429 response
x-microcks-default: true
value:
Message: string
RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
Details: string
'500':
description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api).
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
examples:
AccountNotesDelete500Example:
summary: Default accountNotes_delete 500 response
x-microcks-default: true
value:
Message: string
RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
Details: string
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
components:
schemas:
Unit:
type: object
additionalProperties: false
AccountNoteAdditionResult:
title: AccountNoteAdditionResult
required:
- AccountNotes
type: object
properties:
AccountNotes:
type: array
items:
$ref: '#/components/schemas/AccountNote'
description: Added account notes.
additionalProperties: false
x-schema-id: AccountNoteAdditionResult
EnterpriseProfileData:
title: Enterprise profile data
required:
- ProfileId
type: object
properties:
ProfileId:
type: string
description: Unique identifier of the profile.
format: uuid
example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
additionalProperties: false
x-schema-id: EnterpriseProfileData
AccountNoteResult:
title: AccountNoteResult
required:
- AccountNotes
type: object
properties:
AccountNotes:
type: array
items:
$ref: '#/components/schemas/AccountNote'
description: The set of requested account notes.
Cursor:
type: string
description: Unique identifier of the item one newer in time order than the items to be returned. If Cursor is not specified, i.e. null, then the latest or most recent items will be returned.
format: uuid
nullable: true
example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
additionalProperties: false
x-schema-id: AccountNoteResult
TimeFilterInterval:
title: Time interval
type: object
properties:
StartUtc:
type: string
format: date-time
nullable: true
example: '2026-06-02T14:30:00Z'
EndUtc:
type: string
format: date-time
nullable: true
example: '2026-06-02T14:30:00Z'
additionalProperties: false
description: "When a time interval is used for **filtering** (for example in parameters such as `CreatedUtc.StartUtc` / `CreatedUtc.EndUtc`), the following rules apply:\r\n\r\n- **Start equals End (equality mode)** \r\n If `StartUtc` and `EndUtc` are exactly the same timestamp, the filter is treated as an equality check for that precise moment in time:\r\n \r\n ```\r\n CreatedUtc == StartUtc\r\n ```\r\n \r\n This does not represent an interval; only records with `CreatedUtc` equal to that exact instant are returned.\r\n\r\n- **Start differs from End (interval mode)** \r\n If `StartUtc` and `EndUtc` are different, the filter is evaluated as a half-open interval:\r\n \r\n ```\r\n StartUtc <= CreatedUtc < EndUtc\r\n ```\r\n \r\n In other words, the start is inclusive and the end is exclusive.\r\n\r\nMake sure your integration tak
# --- truncated at 32 KB (52 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mews-systems/refs/heads/main/openapi/mews-systems-account-notes-api-openapi.yml