Get all account notes
POST /api/connector/v1/accountNotes/getAll
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 and supports Portfolio Access Tokens.
Request Body
Section titled “Request Body ”object
Token identifying the client application.
Access token of the client application.
Name and version of the client application.
Limitation on the quantity of data returned and optional Cursor for the starting point of data.
object
Unique identifiers of Chain. If not specified, the operation returns data for all chains within scope of the Access Token.
Unique identifiers of Account note.
Interval of Account note’s last update date and time.
object
Whether to return only active, only deleted or both records.
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
Section titled “ Responses ”OK
object
The set of requested account notes.
object
Unique identifier of the account note.
Unique identifier of the account.
The content of the account note.
Specifying type of associated account.
Company
Customer
Specifying the classifications of the note based on account type.
Whether the account note is still active.
The profile data of the user who created the account note.
object
Enterprise profile data.
object
Unique identifier of the profile.
The profile data of the user who updated the account note.
object
Enterprise profile data.
object
Unique identifier of the profile.
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.
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"}Server has successfully fulfilled the request and there is no additional information to send back.
object
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).
object
Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
object
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.
object
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
object
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.
object
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.