Get note

Retrieve a specific note by its id. The required permission depends on the note's link type: people notes require Read Notes at the person's campuses while multi-campus is on (on your own and your household's profiles your main permissions decide, whatever their campuses; with campus overrides that is the default set capped by what you hold anywhere), and family notes require Read Notes at a campus of one of the family's members while multi-campus is on (on your own family your main permissions decide); groups notes require being an administrator of the group, a member allowed its notes, or holding Full Read Groups, Limited Write Groups or Full Write Groups within your group limits; batches notes require Limited Read Contributions, Full Read Contributions or Limited Write Contributions, and the batch inside your campus access for that permission; without Unrestricted Batches or Full Read Contributions, only your own open batches; a batch of a merchant outside your merchant limits is refused; reconciliations notes require Bank Reconciliations, and Full Read Accounting at every campus while multi-campus is on (at every campus of the reconciliation's bank account's organization while multi-org is on when entity names the reconciliation, and of every organization without it); business notes require Full Read Contributions, Limited Write Contributions, Full Read Accounting or Full Write Accounting, and the business inside your campus access; plan and plan_item notes require Full Read Service Plans or Full Write Service Plans, checked on the plan's campuses when you hold a campus limit or campus overrides; connection notes require Full Read Connections, the connection inside your campus access and within your connection type limits, unless you are the connection's assignee; and workflow_people notes require a role in the note's workflow (Full Read Workflows, Full Write Workflows, manager, or an open assignment in it). A person, family or group note of a note type outside your note type limits is refused (a family note's limits apply at the campuses of the family's members), and any other link type is refused.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required
≥ 1

The id of the note

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json