API Reference
Help Center
  1. GraphQL Admin API

Notes

Notes and note comments.

Queries

note

A single Note by ID

Arguments

  • id (ID!) — The unique identifier of the Note

Returns: Note — An item that can include arbitrary text. It can optionally be associated to a specific customer and have a task attached to it.

noteComment

A single NoteComment by ID

Arguments

  • id (ID!) — The unique identifier of the NoteComment

Returns: NoteComment — A NoteComment is a message associated to a Note by a User

noteComments

Lists NoteComments

Arguments

  • after (String) — A cursor to search after (only include first & after or last & before)
  • before (String) — A cursor to search before (only include first & after or last & before)
  • creatorId (ID) — An ID for a User to filter by
  • first (Int) — The number of results to fetch when searching forward (only include first & after or last & before)
  • includeDeleted (Boolean) — Whether or not to include deleted NoteComments in the results
  • last (Int) — The number of results to fetch when searching backward (only include first & after or last & before)
  • noteId (ID!) — An ID for a Note to filter by
  • search (String) — A search query to filter results
  • sortBy (SortNoteCommentsBy) — The sort key
  • sortDir (SortDirection) — The sort direction

Returns: NoteCommentConnection! — A connection to a list of items.

noteCommentsByIds

A list of NoteComments by IDs

Arguments

  • ids ([ID!]!) — The IDs of the NoteComments

Returns: [NoteComment]! — A NoteComment is a message associated to a Note by a User

notesByIds

A list of Notes by IDs

Arguments

  • ids ([ID!]!) — The IDs of the Notes

Returns: [Note]! — An item that can include arbitrary text. It can optionally be associated to a specific customer and have a task attached to it.

searchNoteComments

🚧

Deprecated: Use Query.noteComments instead

Lists NoteComments

Arguments

  • after (String) — A cursor to search after (only include first & after or last & before)
  • before (String) — A cursor to search before (only include first & after or last & before)
  • creatorId (ID) — An ID for a User to filter by
  • first (Int) — The number of results to fetch when searching forward (only include first & after or last & before)
  • includeDeleted (Boolean) — Whether or not to include deleted NoteComments in the results
  • last (Int) — The number of results to fetch when searching backward (only include first & after or last & before)
  • noteId (ID!) — An ID for a Note to filter by
  • search (String) — A search query to filter results
  • sortBy (SortNoteCommentsBy) — The sort key
  • sortDir (SortDirection) — The sort direction

Returns: NoteCommentConnection! — A connection to a list of items.

searchNotes

Searches Notes

Arguments

  • after (String) — A cursor to search after (only include first & after or last & before)
  • before (String) — A cursor to search before (only include first & after or last & before)
  • filters ([SearchFilterInput!]) — A set of filters to apply
  • first (Int) — The number of results to fetch when searching forward (only include first & after or last & before)
  • last (Int) — The number of results to fetch when searching backward (only include first & after or last & before)
  • search (String) — A search term to apply
  • sortBy (SortNotesBy) — The sort key
  • sortDir (SortDirection) — The sort direction

Returns: NoteConnection! — A connection to a list of items.

Mutations

createNote

Creates a Note

Arguments

  • createdInTeamId (ID) — The Team that the Note was created in
  • creatorId (ID) — The User who is creating the Note
  • customerId (ID) — An ID of the Customer to associate with the Note
  • description (String) — The description of the Note
  • localId (ID) — The local ID of the Note
  • tags ([String!]) — A list of tags to associate with the Note
  • timeZone (String) — The time zone that the Note was created in
  • title (String) — The title of the Note

Returns: CreateNotePayload!

createNoteComment

Creates a NoteComment

Arguments

  • comment (String!) — The content of the NoteComment
  • creatorId (ID!) — The ID of the User who is creating the NoteComment
  • noteId (ID!) — The ID the Note

Returns: CreateNoteCommentPayload!

deleteNoteComment

Deletes a NoteComment

Arguments

  • editorId (ID!) — The ID of the User who is deleting the comment
  • id (ID!) — The ID of the NoteComment

Returns: DeleteNoteCommentPayload!

restoreNoteComment

Restores a NoteComment

Arguments

  • editorId (ID!) — The ID of the User who is deleting the comment
  • id (ID!) — The ID of the NoteComment

Returns: RestoreNoteCommentPayload!

updateNote

Updates a Note

Arguments

  • customerId (ID) — The ID of the Customer to associate with the Note
  • description (String) — The description of the Note
  • editorId (ID) — The User who is updating the Note
  • id (ID!) — The unique identifier of the Note
  • tags ([String!]) — A list of tags to associate with the Note
  • title (String) — The title of the Note

Returns: UpdateNotePayload!

updateNoteComment

Updates a NoteComment

Arguments

  • comment (String!) — The content of the NoteComment
  • id (ID!) — The ID the NoteComment
  • updaterId (ID!) — The ID of the User who is updating the NoteComment

Returns: UpdateNoteCommentPayload!

Objects

CreateNoteCommentError

Fields

CreateNoteCommentFailure

Fields

CreateNoteCommentSuccess

Fields

CreateNoteError

Fields

CreateNoteFailure

Fields

CreateNoteSuccess

Fields

DeleteNoteCommentError

Fields

DeleteNoteCommentFailure

Fields

DeleteNoteCommentSuccess

Fields

Note

An item that can include arbitrary text. It can optionally be associated to a specific customer and have a task attached to it.

Fields

  • analysis_opted_in_at (DateTime) — The date the Note was opted in for analysis
  • assets ([Asset!]!) — The assets associated with the Note — 🚧 Deprecated: Use assets_v2 instead
  • assets_v2 ([NoteAsset!]!) — The assets associated with the Note
  • body_html (String) — The HTML body of the Note
  • body_text (String) — The text body of the Note
  • comments (NoteCommentConnection!) — The NoteComments associated to the Note
  • created_at (DateTime!) — The date the Note was created
  • creator (User) — The User that created the Note
  • customer (Customer) — The customer associated with the Note
  • deleted_at (DateTime) — When the Note was deleted
  • description (String) — The description of the Note — 🚧 Deprecated: Use body_text or body_html instead
  • id (ID!) — The unique identifier of the Note
  • local_id (ID) — The local ID of the Note
  • tags ([String!]!) — Associated tags for the Note
  • task (Task) — The task associated with the Note
  • team (Team) — The Team that the Note was created in
  • time_zone (String) — The time zone that the Note was created in
  • title (String) — The title of the Note
  • type (NoteType!) — The type of Note
  • updated_at (DateTime!) — The date the Note was last updated
  • web_url (URL!) — The URL to the Note inside the web application — 🚧 Deprecated: No longer supported

NoteAsset

An Asset that is associated with a Note

Fields

  • asset (Asset) — The asset associated with the NoteAsset
  • created_at (DateTime!) — The date & time the NoteAsset was created
  • id (ID!) — The unique identifier of the NoteAsset
  • transcription (String) — The transcription of the NoteAsset
  • updated_at (DateTime!) — The date & time the NoteAsset was last updated
  • visibility (NoteAssetVisibility!) — The visibility of the NoteAsset

NoteComment

A NoteComment is a message associated to a Note by a User

Fields

  • body_html (String) — The HTML body of the NoteComment
  • body_text (String) — The text body of the NoteComment
  • comment (String) — The comment text for the NoteComment — 🚧 Deprecated: Use body_text or body_html instead
  • created_at (DateTime!) — The date the NoteComment was created
  • creator (User) — The User that created the NoteComment
  • deleted_at (DateTime) — When the NoteComment was deleted
  • id (ID!) — The unique identifier of the NoteComment
  • is_user_editable (Boolean!) — Whether the NoteComment can be edited by the User
  • note (Note!) — The Note that the NoteComment is associated to
  • updated_at (DateTime!) — The date the NoteComment was last updated
  • web_url (URL!) — The URL to the NoteComment inside the web application — 🚧 Deprecated: No longer supported

NoteCommentConnection

A connection to a list of items.

Fields

NoteCommentEdge

An edge in a connection.

Fields

  • cursor (String!) — A cursor for use in pagination
  • node (NoteComment) — The item at the end of the edge

NoteConnection

A connection to a list of items.

Fields

  • edges ([NoteEdge]) — A list of edges.
  • pageInfo (PageInfo!) — Information to aid in pagination.
  • total (Int)

NoteEdge

An edge in a connection.

Fields

  • cursor (String!) — A cursor for use in pagination
  • node (Note) — The item at the end of the edge

RestoreNoteCommentError

Fields

RestoreNoteCommentFailure

Fields

RestoreNoteCommentSuccess

Fields

UpdateNoteCommentError

Fields

UpdateNoteCommentFailure

Fields

UpdateNoteCommentSuccess

Fields

UpdateNoteError

Fields

UpdateNoteFailure

Fields

UpdateNoteSuccess

Fields

Unions

CreateNoteCommentPayload

Possible types

CreateNotePayload

Possible types

DeleteNoteCommentPayload

Possible types

RestoreNoteCommentPayload

Possible types

UpdateNoteCommentPayload

Possible types

UpdateNotePayload

Possible types

Enums

CreateNoteCommentErrorCode

Values

  • COMMENT_TOO_LONG — The comment exceeds the maximum length of 5000 characters
  • COMMENT_TOO_SHORT — The comment is too short
  • CREATOR_NOT_FOUND — The creator was not found
  • INVALID_COMMENT_HTML — The comment is invalid
  • NOTE_NOT_FOUND — The note was not found

CreateNoteErrorCode

Values

  • ASSET_NOT_FOUND — The asset was not found
  • CREATOR_NOT_FOUND — The creator was not found
  • CUSTOMER_NOT_FOUND — The customer was not found
  • DESCRIPTION_TOO_LONG — The description exceeds the maximum length of 5000 characters
  • INTEGRATED_CUSTOMER_NOT_RESOLVED — The integrated customer could not be resolved to a customer
  • INVALID_DESCRIPTION_HTML — The description is invalid
  • INVALID_LOCAL_ID — The local ID is invalid
  • TEAM_NOT_FOUND — The team was not found

DeleteNoteCommentErrorCode

Values

  • CANNOT_DELETE_NOTE_COMMENT — This note comment cannot be deleted
  • EDITOR_NOT_FOUND — The editor was not found
  • NOTE_COMMENT_NOT_FOUND — The note comment was not found

NoteAssetVisibility

The available visibility types for a NoteAsset

Values

  • NOT_VISIBLE
  • VISIBLE_TO_EVERYONE

NoteType

The type of Note

Values

  • NOTE
  • TASK

RestoreNoteCommentErrorCode

Values

  • CANNOT_RESTORE_NOTE_COMMENT — This note comment cannot be restored
  • EDITOR_NOT_FOUND — The editor was not found
  • NOTE_COMMENT_NOT_FOUND — The note comment was not found

SortNoteCommentsBy

The available keys to sort NoteComments

Values

  • CREATED_AT
  • UPDATED_AT

SortNotesBy

The available keys to sort Notes

Values

  • CREATED_AT
  • UPDATED_AT

UpdateNoteCommentErrorCode

Values

  • CANNOT_UPDATE_DELETED_NOTE_COMMENT — A deleted note comment cannot be updated
  • CANNOT_UPDATE_NOTE_COMMENT — This note comment cannot be updated
  • COMMENT_TOO_LONG — The comment exceeds the maximum length of 5000 characters
  • COMMENT_TOO_SHORT — The comment is too short
  • CONCURRENCY_ERROR — The note comment was updated by another user
  • INVALID_COMMENT_HTML — The comment is invalid
  • NOTE_COMMENT_NOT_FOUND — The note comment was not found

UpdateNoteErrorCode

Values

  • CUSTOMER_NOT_FOUND — The customer was not found
  • DESCRIPTION_TOO_LONG — The description exceeds the maximum length of 5000 characters
  • FORBIDDEN — You do not have permission to perform this action
  • INVALID_DESCRIPTION_HTML — The description is invalid
  • NOTE_NOT_FOUND — The note was not found

Updated 13 days ago

Did this page help you?

Updated 13 days ago

Did this page help you?