---
title: "NoteCollection"
url: "https://stage-api-docs.centraldispatch.com/apis/stage-fulfillment-api-1-0-0/versions/8637c155-7ff6-49fa-ac0a-3b4df78c9665/schemas/NoteCollection"
---

> Full API specification: https://stage-api-docs.centraldispatch.com/apis/stage-fulfillment-api-1-0-0/versions/8637c155-7ff6-49fa-ac0a-3b4df78c9665.md

# NoteCollection

A collection of notes.

## OpenAPI definition

```yaml
openapi: 3.0.1
info:
  title: Fulfillment API
  version: 1.0.0
servers:
  - url: https://fulfillment-api.centraldispatch.com
    description: Production server
components:
  schemas:
    NoteResponse:
      type: object
      properties:
        noteId:
          type: string
          description: The ID of the note.
          format: uuid
          example: 3fde6068-5fa2-4ae4-af16-06d65fc87dc9
        dispatchId:
          type: string
          description: The ID of the dispatch.
          format: uuid
          example: d159acc0-e89b-12d3-a456-426614174000
        customerId:
          type: string
          description: The Central Dispatch customer ID of the customer.
          format: uuid
          example: d5c62b14-cbd1-11ee-9a0e-0242ac110002
        profileType:
          type: string
          description: The profile type of the note author.
          nullable: true
          example: CARRIER
        loadType:
          type: string
          description: The load type associated with the note.
          nullable: true
          example: STANDARD
        displayName:
          type: string
          description: The display name of the note author.
          nullable: true
          example: Mickey Smith
        message:
          type: string
          description: The content of the note.
          example: Carrier called - pickup rescheduled for tomorrow.
        createdDateUtc:
          type: string
          description: The creation date and time of the item, in UTC/ISO 8601 format.
          format: date-time
          example: 2024-10-31T00:00:00Z
        createdBy:
          type: string
          description: The Central Dispatch user ID of the user who created the note.
            Returns the user ID if the note was created by an authenticated end
            user, or the client ID if created via a TMS or client-credentials
            flow.
          format: uuid
          nullable: true
          example: d71b5750-e89b-12d3-a456-426614174000
        visibilityType:
          type: string
          description: "The visibility type of the note. Allowed values: `INTERNAL`.
            Defaults to `INTERNAL` if not provided."
          nullable: true
          example: INTERNAL
        noteSource:
          type: string
          description: The source of the note.
          nullable: true
          example: WEB
      description: Details of an internal load note.
    NoteCollection:
      type: object
      properties:
        href:
          type: string
          description: The URL used to query the current collection of the resource.
          example: https://fulfillment-api.centraldispatch.com/api/fulfillments/id/d159acc0-e89b-12d3-a456-426614174000/notes
        count:
          type: integer
          description: The total count of resources in the collection.
          format: int32
          example: 23
        items:
          type: array
          items:
            $ref: "#/components/schemas/NoteResponse"
          description: A collection of records.
      description: A collection of notes.
```