REregdoor
internal-notes

List Internal Notes

List internal notes for a specific company and parent entity.

Args:

  • company_uuid: The UUID of the company

Filters:

  • parent_pk: The primary key of the parent entity (id or UUID)
  • mentioned_kind + mentioned_uuid: notes whose text mentions that entity
get/api/companies/{company_uuid}/internal-notes/

Request

  • Base URL
    https://api.regdoor.com (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

company_uuidstring uuid required

Query parameters

parent_pkstring nullable

Filter by parent primary key

parent_type'Jurisdiction' | 'Organization' | 'Contact' | 'Interaction' | 'Project' | 'Event' | 'Task'

Parent entity type (required with parent_pk for ACL)

mentioned_kindstring nullable

Entity mention kind in note text (e.g. contact, user)

mentioned_uuidstring uuid nullable

Entity UUID embedded in [[entity:kind:uuid|…]] tokens

pageinteger

Page number

sizeinteger

Page size

Headers

X-User-Emailstring nullable
X-User-Namestring nullable

Response

Successful Response

totalinteger nullable required
pageinteger nullable required
sizeinteger nullable required
pagesinteger nullable

Changes

No recorded changes to this operation across all 1 revision of this API.