Back to Teamwork CRMRetrieve a note
Input
type: object
properties:
parameters:
type: object
properties:
include:
type: string
description: |-
Comma separated list of relationships to include in the response.
See
[including related entities](/crm/general/related-entities)
for more detailed documentation of how this works.
id:
type: integer
required:
- id
title: Parameters
Output
type: object
title: noteResponse
properties:
included:
type: object
title: Included
note:
type: object
title: Note
properties:
createdAt:
type: string
description: When the item was created, as a datetime
format: date-time
createdBy:
type: object
properties:
id:
type: integer
type:
type: string
enum:
- users
deletedAt:
type: string
description: When the item was deleted, as a datetime
format: date-time
deletedBy:
type: object
properties:
id:
type: integer
type:
type: string
enum:
- users
description:
type: string
id:
type: integer
isPinned:
type: boolean
description: >-
Pinned is true when the note should appear immediately after the
section in the UI in which you can create new
notes.
subject:
type: object
properties:
id:
type: integer
description: The id related entity.
type:
type: string
description: The type of the related entity, e.g "users".
updatedAt:
type: string
description: When the item was last updated, as a datetime
format: date-time
updatedBy:
type: object
properties:
id:
type: integer
type:
type: string
enum:
- users
updatedSourceId:
type: integer
description: Source ID of the latest request made (API / Web app)