---
title: "Get a note"
method: GET
path: "/v1/notes/{noteId}"
tags: ["Notes"]
---

# Get a note

`GET /v1/notes/{noteId}`

Retrieves the details of a single note (required scope notes:read)

## Path parameters

- `noteId` integer, required

## Headers

- `Customer-Id` integer, required

## Response `200`

OK

- ReadNoteModel — Read note model
  - `id` integer — The unique identifier of the note
  - `entityType` 'contact' | 'job' | 'stockItem' | 'resource' | 'vehicle' | 'salesOpportunity' | 'contract' — The type of entity that the note is associated to<p>Possible values:</p><ul><li><b>contact</b>: Associated with a contact entity</li><li><b>job</b>: Associated with a job entity</li><li><b>stockItem</b>: Associated with a stock item entity</li><li><b>resource</b>: Associated with a resource entity</li><li><b>vehicle</b>: Associated with a vehicle entity</li><li><b>salesOpportunity</b>: Associated with a sales opportunity entity</li><li><b>contract</b>: Associated with a contract entity</li></ul>
  - `entityId` integer — The unique identifier of the associated entity that owns the note, relative to the `entityType`
  - `contactId` integer, nullable — The unique identifier of the contact associated to this note
  - `typeId` integer — The unique identifier of the note type definition associated to this note
  - `createdAt` string, date-time — The UTC timestamp of when this note was created
  - `subject` string — The subject of the note
  - `parentId` integer, nullable — The unique identifier of the parent note of this note
  - `dueAt` string, date-time, nullable — The UTC timestamp of when this note is due for completion
  - `progressedAt` string, date-time, nullable — The UTC timestamp of when this note was last progressed
  - `reference` string — The internal reference of the note - should usually be unique
  - `status` 'open' | 'completed' | 'cancelled' — The status of the note<p>Possible values:</p><ul><li><b>open</b>: Open</li><li><b>completed</b>: Completed</li><li><b>cancelled</b>: Cancelled</li></ul>
  - `description` string — The detailed textual content about the note
  - `completionText` string, nullable — A textual note that can be added when a note has been completed. Can only be set if the note has a completed status
  - `progressPercentage` integer — The percentage of work done required to complete the note
  - `createdByUserName` string — The name of the user who owns the note
  - `ownedByUserId` integer — The unique id of the user who owns the note
  - `ownedByUserName` string — The name of the user who owns the note
  - `customFields` CustomFieldReadModel[] — The collection of custom fields applied to this note
    - `definitionId` integer — The unique identifier of the associated custom field definition
    - `value` string, nullable — The current value set for the custom field
    - `definition` CustomFieldEmbeddedDefinitionModel — Represents the definition of a custom field
      - `caption` string — The caption of a custom field
      - `type` 'boolean' | 'integer' | 'decimal' | 'text' | 'list' | 'statement' | 'date' | 'note' | 'time' | 'systemList' — The type of the custom field. New field types may be added in the future, so integrations should be resilient to this<p>Possible values:</p><ul><li><b>boolean</b>: Indicates a boolean field <i>(Example: "false")</i></li><li><b>integer</b>: Indicates an integer numeric field <i>(Example: "1001")</i></li><li><b>decimal</b>: Indicates a floating point numeric field <i>(Example: "1.42")</i></li><li><b>text</b>: Indicates an editable text field <i>(Example: "Purple")</i></li><li><b>list</b>: Indicates a field with a single value from a predefined list of options <i>(Example: "Purple")</i></li><li><b>statement</b>: Indicates a text field that cannot be edited. The value is always equal to the default value <i>(Example: "By signing this you agree to the following...")</i></li><li><b>date</b>: Indicates a date field, which will be represented as an RFC3339 formatted date string. The default value is not supported for this type and will always be null <i>(Example: "2024-01-31")</i></li><li><b>note</b>: Indicates a multiline, editable text field. Lines are seperated with a line feed character <i>(Example: "This is a note.")</i></li><li><b>time</b>: Indicates a time field, formatted as HH:mm. The default value is not supported for this type and will always be null <i>(Example: "10:30")</i></li><li><b>systemList</b>: Indicates the ID of a related resource, vehicle or web user <i>(Example: "228007")</i></li></ul>
      - `listOptions` string[], nullable — Shows the possible values for a list type custom field. Value will be null if type is not list
      - `isRequired` boolean — Indicates if the field is required in the UI. This is NOT enforced in the API
      - `isEditable` boolean — Indicates if the field is editable
      - `default` string, nullable — The default value of a custom field. Formatted in accordance with the rules of the field type
    - `systemListValueMetadata` SystemListValueMetadataModel — Represents details of custom field value of type system list
      - `label` string, nullable — A descriptive label for the specific resource, vehicle or web user that this system list value relates to
      - `entityType` 'resource' | 'vehicle' | 'webUser' — The type of entity used for custom field value of type system list<p>Possible values:</p><ul><li><b>resource</b></li><li><b>vehicle</b></li><li><b>webUser</b></li></ul>

## Other responses

- `400` — Bad Request
- `403` — Forbidden
- `404` — Not Found
- `500` — Internal Server Error

---

[API](https://skmtc.net/bigchange/apis/bigchange-dx.md) · [All operations](https://skmtc.net/bigchange/apis/bigchange-dx/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bigchange/bigchange-dx/revisions/916e669fc527/schema)