List Notes - Circuit Auction API

GET /notes

Query Parameters

Parameter	Type	Description	Example
`filter[reference]`	string	Filter notes by reference node ID (item, sale, order, etc.)	`?filter[reference]=1890911`
`sort`	string	Sort order (prefix with - for descending)	`?sort=-created`
`range`	integer	Number of items per page	`?range=25`
`page`	integer	Page number (0-indexed)	`?page=0`

Example Request

GET /api/v1.0/notes?filter[reference]=1890911&sort=-created

Response

{
  "data": [
    {
      "id": 2044744,
      "label": "Important Note",
      "published": "1",
      "created": 1764691706000,
      "updated": 1764691706000,
      "author": {
        "id": "161",
        "label": "John Stewart",
        "mail": "John@circuitauction.com",
        "value": "161",
        "uuid": "2a66b8b2-2fae-4179-9989-f8e5b05c98ad"
      },
      "vid": "6245178",
      "reference": {
        "id": "2005",
        "uuid": "692f0e45ed2601-81558186",
        "label": "Adam Smith - 7246",
        "type": "client",
        "url_api": "/node/2005",
        "app_url": "https://backoffice.ddev.site/app#dashboard/clients/2005/client"
      },
      "note": "Do not forget to check the item condition before shipping.",
      "documents": null
    }
  ],
  "count": 1,
  "self": {
    "title": "Self",
    "href": "https://backoffice.ddev.site/en/api/v1.0/notes"
  }
}

Response Fields

Field	Type	Description
`id`	integer	Unique note ID
`label`	string	Note title or preview text
`published`	string	Published status ("1" = published, "0" = unpublished)
`created`	number	Unix timestamp in milliseconds when note was created
`updated`	number	Unix timestamp in milliseconds when note was last updated
`author`	object	User who created the note
`author.id`	string	Author's user ID
`author.label`	string	Author's full name
`author.mail`	string	Author's email address
`author.value`	string	Author's user ID (duplicate of id)
`author.uuid`	string	Author's UUID
`vid`	string	Version ID of the note
`reference`	object	The entity this note is attached to (item, sale, order, client, etc.)
`reference.id`	string	ID of the referenced entity
`reference.uuid`	string	UUID of the referenced entity
`reference.label`	string	Display name of the referenced entity
`reference.type`	string	Entity type (e.g., "client", "item", "sale", "order")
`reference.url_api`	string	API endpoint path for the referenced entity
`reference.app_url`	string	Web application URL to view the referenced entity
`note`	string	The note content as HTML (may contain <p> tags and other HTML)
`documents`	array or null	Attached documents/files, or null if no documents
`documents[].id`	string	File ID
`documents[].filename`	string	Original filename
`documents[].filemime`	string	MIME type (e.g., application/pdf, image/jpeg)
`documents[].filesize`	string	File size in bytes
`documents[].url`	string	Direct URL to download the file

Usage Notes

Notes can be attached to various entity types including items, sales, orders, and clients
Use filter[reference] to get all notes for a specific entity
Notes are typically sorted by creation date in descending order (sort=-created)
Documents attached to notes can include PDFs, images, and other file types