Notes in Core

It is possible to add one or several notes to a contact, case, or even bid in Core. Each note can be attached to multiple contacts, cases, or bids at a time. It is also possible to attach a note to an invoice, but only one invoice at a time.

Retrieving all notes attached to a Contact

To get all notes for a given contact, you will need the following permissions:

Contacts - Read
Notes - Read

Use the following endpoint:

GET /flow/api/Notes/Contact/{contactId}

For example:

GET /flow/api/Notes/Contact/143420

If the person has any notes you should get a response similar to:

[
    {
        "Id": 29036,
        "Message": "Some note",
        "CreatedDate": "2024-07-02T09:54:06.8845136+02:00",
        "CreatedById": 141746,
        "NoteType": "Overview",
        "ContactIds": [
            141746,
            143420,
            88055
        ],
        "CaseIds": [
            74650,
            74651
        ],
        "BidIds": [],
        "InvoiceSerialNumbers": [],
        "IsBidComment": false,
        "IsImportant": false,
        "NoteParentType": "Stakeholder",
        "NoteTypes": [
            "Overview"
        ],
        "IsReadOnly": false,
        "OwnerCaseType": "Unknown"
    },
    ...
]

As you can see in the response, this particular note has several ContactIds. This means that the note is attached to all of those contacts and you can retrieve it by using any of the contact IDs, e.g.

GET /flow/api/Notes/Contact/141746
GET /flow/api/Notes/Contact/143420
GET /flow/api/Notes/Contact/88055

Retrieving all notes attached to a Case

To get all notes for a given case, you will need the following permission:

Notes - Read

With this, you will be able to retrieve notes of the type Overview. If you want to retrieve notes that has the type Economics as well, then you will also need the permission:

SettlementView - Read

Use the following endpoint:

GET /flow/api/Notes/Case/{caseId}

You should receive a response similar to the one described in the Retrieving all notes attached to a Contact section.

Note that with this endpoint, you can only retrieve the notes where the case is the owner of the note. A note owner is the entity that owns the note, and each note can have only one owner.

Retrieving the Note Owner for a Specific Note

To find the owner of a specific note, you will need the following permissions:

Contacts - Read
Cases - Read
Bids - Read
Notes - Read

You should receive a response similar to:

{
    "OwnerId": 74650,
    "OwnerType": "Case"
}

Table of contents