Skip to main content

notes

The Notes query is used to retrieve notes associated with a specific object, referred to as the 'notable' object. It requires a notable_type and notable_id to identify the notable object, and an optional NoteFiltersInput object to filter the results. Each field in the NoteFiltersInput corresponds to a specific attribute in the notes and is optional. If a field is provided, the query will return only the notes that match the provided value for that field.

ArgumentTypeDescription
notable_typeEnumThe type of the notable object.
notable_idIDThe ID of the notable object.
filtersNoteFiltersInputAn object used to filter the results of the Notes query.

The query returns an array of NoteType objects. Each NoteType object represents a note and includes the following fields: content, author_id, notable_type, notable_id, created_at, and updated_at.

Possible errors include NotableError if the notable_id and notable_type fields do not correspond to a valid notable object, and AuthenticationError if the user is not authenticated.

notes(
after: String
before: String
filters: NoteFiltersInput
first: Int
last: Int
notableId: ID!
notableType: NotableObjectEnum!
): NoteConnection!

Arguments

notes.after ● String scalar

Returns the elements in the list that come after the specified cursor.

notes.before ● String scalar

Returns the elements in the list that come before the specified cursor.

notes.filters ● NoteFiltersInput input

An object used to filter the results of the Notes query. This field is optional.

notes.first ● Int scalar

Returns the first _n_ elements from the list.

notes.last ● Int scalar

Returns the last _n_ elements from the list.

notes.notableId ● ID! non-null scalar

The ID of the notable object. This field is required.

notes.notableType ● NotableObjectEnum! non-null enum

The type of the notable object. This field is required.

Type

NoteConnection object

The connection type for Note.