Skip to content

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

Position

_id
String!,non-null
title
String
code
String
order
String
parentId
String
parent
status
String
children
users
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 }

PriceRange

Min/max price summary for variants.

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

PriorityChangedPayload

Payload for priority_changed action.

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

ScoreCategories

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

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

ScoreCategoryEntry

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

score
Float
actions
Int
Sample
{ "score": 40, "actions": 40 }

StatusChangedPayload

Payload for status_changed action.

from
String
to
String
status
String
performedBy
String
viaAutomation
Boolean
performedByUser

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

Submission

_id
String!,non-null
contentTypeId
String
customerId
String
customer
createdAt
customFieldsData
submissions
Sample
{ "_id": "Example String", "contentTypeId": "Example String", "customerId": "Example String", "customer": { "__typename": "Customer" }, "createdAt": "Example Custom Scalar", "customFieldsData": "Example Custom Scalar", "submissions": [ { "__typename": "FormSubmission" } ] }

SuccessResult

success
Boolean
Sample
{ "success": true }

TemplateRendered

Rendered snapshot of a template message.

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

TemplateRenderedButton

type
String
text
String
url
String
phone_number
String
coupon_code
String
Sample
{ "type": "Example String", "text": "Example String", "url": "Example String", "phone_number": "Example String", "coupon_code": "Example String" }

TemplateRenderedCarouselCard

body
String
Sample
{ "header": { "__typename": "TemplateRenderedHeader" }, "body": "Example String", "buttons": [ { "__typename": "TemplateRenderedButton" } ] }

Unions

Overview

Enums

Overview

Inputs

Overview

Scalars

Overview