Skip to content
Developers/
Other
/
/
ScoreCategories

GraphQL Overview

Browse queries, mutations, and types in the schema reference. For authentication, endpoint URLs, and domain guides, see the API Overview.

Conversations & messaging

Queries

Overview

Mutations

Overview

Objects

Overview

Enums

Overview
Contacts & CRM

Queries

Overview

Mutations

Overview

Objects

Overview

Inputs

Overview
Products & commerce

Queries

Overview

Mutations

Overview

Objects

Overview
Apps & credentials

Queries

Overview

Mutations

Overview

Objects

Overview
Organization

Queries

Overview

Objects

Overview

Enums

Overview
Other

Queries

Overview

Mutations

Overview

Objects

Overview

ParticipantRemovedPayload

Payload for participant_removed action.

removedUserIds
[String]
performedBy
String
removedUsers
[User]

Resolved users who were removed (by removedUserIds).

performedByUser
User

Resolved user who performed the removal.

Sample
{
  "removedUserIds": [
    "Example String"
  ],
  "performedBy": "Example String",
  "removedUsers": [
    {
      "__typename": "User"
    }
  ],
  "performedByUser": {
    "__typename": "User"
  }
}
Referenced in
ActionsPayload

PdfAttachment

A PDF attachment with its individual page images.

pdf
Attachment

The full PDF file.

pages
[Attachment]

Individual page images extracted from the PDF.

Sample
{
  "pdf": {
    "__typename": "Attachment"
  },
  "pages": [
    {
      "__typename": "Attachment"
    }
  ]
}
Referenced in
KnowledgeBaseArticle.pdfAttachment

Position

_id
String!,non-null
title
String
code
String
order
String
parentId
String
parent
Position
status
String
children
[Position]
users
[User]
userIds
[String]
userCount
Int
Sample
{
  "_id": "Example String",
  "title": "Example String",
  "code": "Example String",
  "order": "Example String",
  "parentId": "Example String",
  "parent": {
    "__typename": "Position"
  },
  "status": "Example String",
  "children": [
    {
      "__typename": "Position"
    }
  ],
  "users": [
    {
      "__typename": "User"
    }
  ],
  "userIds": [
    "Example String"
  ],
  "userCount": 40
}
Referenced in
Position.parent
Position.children
User.positions

PriceRange

Min/max price summary for variants.

min
Float
max
Float
currency
String
Sample
{
  "min": 40,
  "max": 40,
  "currency": "Example String"
}
Referenced in
Product.priceRange

PriorityChangedPayload

Payload for priority_changed action.

priority
String
Sample
{
  "priority": "Example String"
}
Referenced in
ActionsPayload

ScoreCategories

Breakdown of a user's score across different activity categories.

speed
ScoreCategoryEntry
quality
ScoreCategoryEntry
productivity
ScoreCategoryEntry
training
ScoreCategoryEntry
engagement
ScoreCategoryEntry
Sample
{
  "speed": {
    "__typename": "ScoreCategoryEntry"
  },
  "quality": {
    "__typename": "ScoreCategoryEntry"
  },
  "productivity": {
    "__typename": "ScoreCategoryEntry"
  },
  "training": {
    "__typename": "ScoreCategoryEntry"
  },
  "engagement": {
    "__typename": "ScoreCategoryEntry"
  }
}
Referenced in
User.scoreCategories

ScoreCategoryEntry

Individual score category tracking (speed, quality, productivity, training, engagement).

score
Float
actions
Int
Sample
{
  "score": 40,
  "actions": 40
}
Referenced in
ScoreCategories.speed
ScoreCategories.quality
ScoreCategories.productivity
ScoreCategories.training
ScoreCategories.engagement

StatusChangedPayload

Payload for status_changed action.

from
String
to
String
status
String
performedBy
String
viaAutomation
Boolean
performedByUser
User

Resolved user who performed the status change.

Sample
{
  "from": "Example String",
  "to": "Example String",
  "status": "Example String",
  "performedBy": "Example String",
  "viaAutomation": true,
  "performedByUser": {
    "__typename": "User"
  }
}
Referenced in
ActionsPayload

Submission

_id
String!,non-null
contentTypeId
String
customerId
String
customer
Customer
createdAt
Date
customFieldsData
JSON
submissions
[FormSubmission]
Sample
{
  "_id": "Example String",
  "contentTypeId": "Example String",
  "customerId": "Example String",
  "customer": {
    "__typename": "Customer"
  },
  "createdAt": "Example Custom Scalar",
  "customFieldsData": "Example Custom Scalar",
  "submissions": [
    {
      "__typename": "FormSubmission"
    }
  ]
}
Referenced in
FormSubmissionListResponse.data

SuccessResult

success
Boolean
Sample
{
  "success": true
}

TemplateRendered

Rendered snapshot of a template message.

header
TemplateRenderedHeader
body
String
footer
String
buttons
[TemplateRenderedButton]
carousel
[TemplateRenderedCarouselCard]
lto
TemplateRenderedLTO
Sample
{
  "header": {
    "__typename": "TemplateRenderedHeader"
  },
  "body": "Example String",
  "footer": "Example String",
  "buttons": [
    {
      "__typename": "TemplateRenderedButton"
    }
  ],
  "carousel": [
    {
      "__typename": "TemplateRenderedCarouselCard"
    }
  ],
  "lto": {
    "__typename": "TemplateRenderedLTO"
  }
}
Referenced in
MessageTemplate.rendered

Unions

Overview

Enums

Overview

Inputs

Overview

Scalars

Overview