snippet

QUERY

snippet(snippetId: ID!): Snippet

Arguments

snippetId

ID!

required

Returns

Snippet

ID!

name

String!

text

String!

The plain-text body of the snippet, used in channels that do not render markdown.

markdown

String

Optional markdown body. When present, this is preferred over text in rich-text channels.

path

String

Folder path used to group snippets in the Plain app. Only alphanumeric characters are allowed. Null means the snippet is ungrouped.

isDeleted

Boolean!

Whether the snippet has been soft-deleted. Soft-deleted snippets are hidden from the snippet picker but remain queryable by ID.

createdAt

createdBy

updatedAt

updatedBy

deletedAt

The timestamp at which the snippet was soft-deleted, or null if it has not been deleted.

deletedBy

InternalActor

The user or machine user that deleted the snippet, or null if it has not been deleted.

Query

query Snippet($snippetId: ID!) {
  snippet(snippetId: $snippetId) {
    id
    name
    text
    markdown
    path
    isDeleted
  }
}

Variables

{
  "snippetId": "id"
}

Response

{
  "data": {
    "snippet": {
      "id": "id",
      "name": "string",
      "text": "string",
      "markdown": "string",
      "path": "string",
      "isDeleted": true
    }
  }
}

⌘I

Query

query Snippet($snippetId: ID!) {
  snippet(snippetId: $snippetId) {
    id
    name
    text
    markdown
    path
    isDeleted
  }
}

Variables

{
  "snippetId": "id"
}

Response

{
  "data": {
    "snippet": {
      "id": "id",
      "name": "string",
      "text": "string",
      "markdown": "string",
      "path": "string",
      "isDeleted": true
    }
  }
}

Queries

Mutations

Types

Arguments

Returns