Get a note

Example Query

query ExampleQuery($id: String!) {
  note(id: $id) {
    content
    createdAt
    createdByUser {
      avatarUrl
      contact
      createdAt
      email
      firstName
      fullName
      id
      lastName
      stateEnum
      updatedAt
    }
    edited
    externalId
    id
    noteNumber
    noteable
    sourceEnum
    taggings {
      createdAt
      id
      tag
      tagContext
      taggableId
      taggableType
      updatedAt
    }
  }
}

Variables

{
  "id": "example"
}

Example response

{
  "data": {
    "note": {
      "content": "example",
      "createdAt": "example",
      "createdByUser": {
        "avatarUrl": "example",
        "contact": {
          "archivedAt": null,
          "archivedByUser": null,
          "contactAddresses": null,
          "contactCitizenships": null,
          "contactClassifications": null,
          "contactDetails": null,
          "contactOrganizations": null,
          "contactRoles": null,
          "createdAt": null,
          "createdByUser": null
        },
        "createdAt": "example",
        "email": "example",
        "firstName": "example",
        "fullName": "example",
        "id": "example",
        "lastName": "example",
        "stateEnum": "disabled",
        "updatedAt": "example"
      },
      "edited": true,
      "externalId": "example",
      "id": "example",
      "noteNumber": "example",
      "noteable": {
        "accountLeadInstitution": true,
        "accountPastPatentExpenses": 0,
        "accountShareOfNetConsideration": 0,
        "accountShareOfPatentCost": 0,
        "adminFeeAmount": 0,
        "adminFeeCap": 0,
        "adminFeePercentage": 0,
        "agreementAccountClassifications": [
          {
            "accountClassification": null,
            "createdAt": null,
            "id": null,
            "updatedAt": null
          }
        ],
        "agreementClassifications": [
          {
            "classification": null,
            "createdAt": null,
            "id": null,
            "updatedAt": null
          }
        ],
        "agreementContacts": [
          {
            "contact": null,
            "contactRoleEnum": null,
            "createdAt": null,
            "department": null,
            "id": null,
            "revenueDistributionPercentage": null,
            "updatedAt": null
          }
        ]
      },
      "sourceEnum": "admin",
      "taggings": [
        {
          "createdAt": "example",
          "id": "example",
          "tag": {
            "color": null,
            "createdAt": null,
            "createdByUser": null,
            "id": null,
            "name": null,
            "taggingsCount": null,
            "updatedAt": null,
            "updatedByUser": null
          },
          "tagContext": "example",
          "taggableId": "example",
          "taggableType": "example",
          "updatedAt": "example"
        }
      ]
    }
  }
}

Returns a note by ID.

Arguments

idStringRequired

The ID of the note to return.

Returns

a Note

createdAtString

The note's creation date.

editedBoolean

Whether the note has been edited since it was created.

idString

The note's unique identifier.

taggingslist of Taggings

The tags applied to the note.

updatedAtString

The date the note was last updated.

contentStringOptional

The note's text.

createdByUserUserOptional

The user who created the note.

externalIdStringOptional

The note's identifier in an external system. Set when the note is imported.

noteNumberStringOptional

The note's number. Unique among the notes on the same record.

noteableNoteableUnionOptional

The record the note belongs to. Returns null for record types the API does not expose.

sourceEnumNoteSourceEnumOptional

How the note was created, such as manually or by import.

Allowed values:

titleStringOptional

The note's title.

updatedByUserUserOptional

The user who last edited the note.