Notrus

Schema Reference

Every type, field, and argument in the Notrus read API, generated from the live schema.

type

Query

conversation
Conversation

A single conversation by your platform-native conversation id; null if not found.

  • conversationIdString!Your platform-native conversation id.
conversations
ConversationConnection!

Paginated list of conversations for the authenticated organization, oldest first.

  • afterStringOpaque cursor from a previous page's `pageInfo.endCursor`.
  • firstIntPage size (server-capped).
type

ClassifiedCategory

The category a thread was classified into, from your category catalog.

identifier
String!

Stable machine identifier of the category.

name
String!

Human-readable name of the category.

subcategory
String

Subcategory grouping, when defined.

type

Conversation

A conversation — the threads sharing one platform-native conversation id.

conversationId
String!

Your platform-native conversation id, exactly as sent to Notrus.

threads
[Thread!]!

The threads that belong to this conversation, oldest first.

type

ConversationConnection

A Relay-style page of conversations.

edges
[ConversationTypeEdge!]!
pageInfo
PageInfo!
type

ConversationTypeEdge

cursor
String!

Opaque cursor identifying this edge for pagination.

node
Conversation!

The item at this edge.

scalar

DateTime

A date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date-time format.

type

PageInfo

Relay-style pagination metadata for a connection page.

endCursor
String

Opaque cursor to pass as `after` for the next page; null on an empty page.

hasNextPage
Boolean!

True if more items exist after this page.

type

Thread

A thread within a conversation, projected to its classification state.

chatState
[TagLink!]!

Chat-state values applied to the thread, oldest first.

classifiedCategory
ClassifiedCategory

The category the thread was classified into; null when not categorized.

classifierState
[TagLink!]!

Classifier-state values applied to the thread, oldest first.

summary
String

Notrus's justificative summary of the thread, when produced.

threadId
ID!

Internal Notrus thread identifier (opaque, stable).