YOWO7 API
CRM Notes

GET

/api/v1/workspaces/{workspaceId}/crm/{objectSlug}/records/{recordId}/notes/{noteId}

Scope crm:read

Read a single note on a CRM record.

Pfad

workspaceIdPflicht
string (uuid)
Workspace that owns the resource.
objectSlugPflicht
string
CRM object slug, for example contact.
recordIdPflicht
string (uuid)
CRM record identifier.
noteIdPflicht
string (uuid)
Note identifier.

Antworten

200CrmNoteDtoThe request succeeded. The JSON body contains url, data, and meta. The linked schema is data.

CRM note.

id
string (uuid)
Identifier.
recordId
string (uuid)
Identifier of the record.
bodyPflicht
string
Body content.
isPinned
boolean
Whether this is pinned.
createdByUserId
string (uuid)
Member who created this.
updatedByUserId
string (uuid)
Member who last updated this.
createdAt
string (date-time)
When this was created.
updatedAt
string (date-time)
When this was last updated.
400ApiProblemThe request is invalid.
401ApiProblemThe private app token is missing or invalid.
403ApiProblemThe token is missing the required scope, or this action is not allowed.
404ApiProblemThe workspace or resource was not found.
defaultApiProblemError response.