--- title: "Get Dispatch Notes" url: "https://stage-api-docs.centraldispatch.com/apis/stage-fulfillment-api-1-0-0/versions/8637c155-7ff6-49fa-ac0a-3b4df78c9665/operations/getDispatchNotes" --- > Full API specification: https://stage-api-docs.centraldispatch.com/apis/stage-fulfillment-api-1-0-0/versions/8637c155-7ff6-49fa-ac0a-3b4df78c9665.md # Get Dispatch Notes `GET` `/api/fulfillments/id/{dispatchId}/notes` Operation ID: `getDispatchNotes` Get the most recent notes for the given dispatch, ordered by creation date descending. Returns up to 500 notes scoped to the caller's customer ID and profile type. ## Path parameters - `dispatchId` (string, uuid, required) - The ID of the dispatch. ## Header parameters - `Accept` (string, required) - The major version of the API to make a request against. This is a custom MIME type that contains `vnd.coxauto.v[#]+`. For example, to request a resource from version 1.x.x of an API, the Accept header should be set to `application/vnd.coxauto.v1+json`. ## Responses - `200` - OK. Successful request. - `400` - Bad Request. Check the request payload. **Scenarios:** - Invalid or missing dispatch ID. - `401` - Unauthorized - `403` - Forbidden - `404` - Not Found. - `409` - Conflict. Update not allowed based on the current resource state. **Scenarios:** - Dispatch is in archived status. - `429` - Too Many Requests. Rate limit exceeded. - `500` - Error. - `503` - Service Unavailable. Temporary service interruption. ## 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 paths: /api/fulfillments/id/{dispatchId}/notes: get: tags: - Dispatch summary: Get Dispatch Notes description: Get the most recent notes for the given dispatch, ordered by creation date descending. Returns up to 500 notes scoped to the caller's customer ID and profile type. operationId: getDispatchNotes parameters: - name: dispatchId in: path description: The ID of the dispatch. required: true schema: type: string format: uuid example: d159acc0-e89b-12d3-a456-426614174000 - name: Accept in: header description: The major version of the API to make a request against. This is a custom MIME type that contains `vnd.coxauto.v[#]+`. For example, to request a resource from version 1.x.x of an API, the Accept header should be set to `application/vnd.coxauto.v1+json`. required: true schema: type: string example: application/vnd.coxauto.v1+json responses: "200": description: OK. Successful request. headers: X-CoxAuto-Media-Type: description: Contains the major version and format information. schema: type: string example: coxauto.v1; format=json content: application/json: schema: $ref: "#/components/schemas/NoteCollection" "400": description: |- Bad Request. Check the request payload. **Scenarios:** - Invalid or missing dispatch ID. content: application/json: schema: $ref: "#/components/schemas/ErrorsAlt" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorsAlt" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorsAlt" "404": description: Not Found. content: application/json: schema: $ref: "#/components/schemas/ErrorsAlt" "409": description: |- Conflict. Update not allowed based on the current resource state. **Scenarios:** - Dispatch is in archived status. content: application/json: schema: $ref: "#/components/schemas/ErrorsAlt" "429": description: Too Many Requests. Rate limit exceeded. "500": description: Error. content: application/json: schema: $ref: "#/components/schemas/ErrorsAlt" "503": description: Service Unavailable. Temporary service interruption. security: - Bearer: [] security: - Bearer: [] components: schemas: 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. ErrorsAlt: type: object properties: errors: type: array items: $ref: "#/components/schemas/ErrorAlt" description: A collection of errors. nullable: true description: An error occurred, and the request could not be completed. 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. ErrorAlt: type: object properties: errorID: type: string description: The ID of the error. nullable: true example: 157a16f0-503d-4256-ba60-a4876e8eb9bb code: type: string description: The code used for the issue. nullable: true example: resource.issue_type description: type: string description: A detailed message. nullable: true example: The issue happened because something is wrong. properties: type: array items: $ref: "#/components/schemas/ErrorAltProperty" description: Properties related to the issue. nullable: true description: Details of an error or issue. ErrorAltProperty: type: object properties: property: type: string description: The name of the property. nullable: true example: person value: type: string description: The value of the property. nullable: true example: J0hn D03 description: Details of an error's property. securitySchemes: Bearer: type: http scheme: Bearer ```