Queries

ai_task (company)

Schema: company

A single task of the calling company's, by id.

Backs the runs page, which is reached by link and knows only the id. Null when the id isn't theirs — a caller can't tell "someone else's" from "gone", and doesn't need to.

Type: Query

Returns: AiTask

ai_task(
  id: Id!
): AiTask

ai_task (user)

Schema: user

A single task of the calling user's, by id.

Backs the runs page, which is reached by link and knows only the id. Null when the id isn't theirs — a caller can't tell "someone else's" from "gone", and doesn't need to.

Type: Query

Returns: AiTask

ai_task(
  id: Id!
): AiTask

ai_task_runs

Schema: user, company

Type: Query

Returns: PaginatedAiTaskRuns

ai_task_runs(
  "Cursor for the next page; pass back `pagination_info.next_cursor` from the previous response"
  cursor: String
  "Limit number of results per page; defaults are applied if omitted"
  limit: Integer
  task_id: Id!
): PaginatedAiTaskRuns

ai_tasks

Schema: user, company

Type: Query

Returns: PaginatedAiTasks

ai_tasks(
  "Cursor for the next page; pass back `pagination_info.next_cursor` from the previous response"
  cursor: String
  "Filter to tasks that watch this folder. A task watching an ancestor covers the folder's documents without being about the folder, and is left out"
  folder_id: Id
  "Limit number of results per page; defaults are applied if omitted"
  limit: Integer
): PaginatedAiTasks

b2b_connections

Schema: company

Type: Query

Returns: [B2bConnection]

b2b_connections(
  "Filter by excluding the type of the connection"
  excluded_type: B2bConnectionType
  "Filter by the type of the connection"
  included_type: B2bConnectionType
  "Limit number of results"
  limit: Integer
): [B2bConnection]

b2c_connection_notification_settings

Schema: user

Type: Query

Returns: B2cConnectionNotificationSettings

b2c_connection_notification_settings(
  "The ID of the B2C connection"
  b2c_connection_id: Id!
): B2cConnectionNotificationSettings

b2c_connections

Schema: user, company

Type: Query

Returns: [B2cConnection]

b2c_connections(
  "Filter by excluding the type of the connection"
  excluded_type: B2cConnectionType
  "Filter by the type of the connection"
  included_type: B2cConnectionType
  "Limit number of results"
  limit: Integer
): [B2cConnection]

b2c_subscription_topics

Schema: company

Type: Query

Returns: [B2cSubscriptionTopic]

b2c_subscription_topics: [B2cSubscriptionTopic]

b2c_subscriptions

Schema: user, company

Type: Query

Returns: PaginatedB2cSubscriptions

b2c_subscriptions(
  "Filter by the company of the subscription"
  company_id: Id
  "Cursor to get the next batch of results (null if none)"
  cursor: String
  "Filter by excluding subscriptions with the B2C subscription topic by passing the topic"
  excluded_topic: String
  "Filter by the expiration date of the subscription"
  expiration_date_after: Date
  "Filter by the expiration date of the subscription"
  expiration_date_before: Date
  "Filter by including subscriptions with the B2C subscription topic by passing the topic"
  included_topic: String
  "Limit number of results"
  limit: Integer
  "Filter by the type (channel) of the subscription"
  types: [B2cSubscriptionType!]
  "Filter by the user of the subscription"
  user_id: Id
): PaginatedB2cSubscriptions

c2c_connections

Schema: user

Type: Query

Returns: [C2cConnection]

c2c_connections(
  "Filter by excluding the type of the connection"
  excluded_type: C2cConnectionType
  "Filter by the type of the connection"
  included_type: C2cConnectionType
  "Limit number of results"
  limit: Integer
): [C2cConnection]

client_secrets

Schema: company

Type: Query

Returns: [ClientSecret!]!

client_secrets: [ClientSecret!]!

companies

Schema: user, company

Type: Query

Returns: [Company]

companies(
  email: String
  id: Id
  limit: Integer
  "Filter by metadata, e.g. {"key" => "value"}, only exact match is supported"
  metadata: Json
  "Filter by legal name, brand name or profile name"
  name: String
  tax_id: String
  telephone_number: String
  webpage: String
): [Company]

company_dashboard_stats

Schema: company

Type: Query

Returns: CompanyDashboardStats

company_dashboard_stats: CompanyDashboardStats

company_document

Schema: company

Type: Query

Returns: Document

company_document(
  "The document id"
  id: Id!
): Document

company_documents

Schema: company

Type: Query

Returns: PaginatedDocuments

company_documents(
  "Cursor for the next page; pass back `pagination_info.next_cursor` from the previous response"
  cursor: String
  "Scope to a folder's contents, or with an explicit null to the repository root; omit for no folder filter"
  folder_id: Id
  "Limit number of results per page; defaults are applied if omitted"
  limit: Integer
  "Filter by file name"
  search: String
  "Filter by status; defaults to accepted"
  status: DocumentStatus
  "Filter to documents carrying any of these tag ids"
  tag_ids: [Id!]
): PaginatedDocuments

company_folders

Schema: company

Type: Query

Returns: FoldersPage

company_folders: FoldersPage

company_form

Schema: company

Type: Query

Returns: Form

company_form(
  "The ID of the form"
  id: Id!
): Form

company_forms

Schema: company

Type: Query

Returns: PaginatedForms

company_forms(
  "Cursor for pagination"
  cursor: String
  "Limit number of results"
  limit: Integer
): PaginatedForms

company_invitation_links

Schema: company

Type: Query

Returns: [InvitationLink]

company_invitation_links(
  "Limit number of results"
  limit: Integer
): [InvitationLink]

company_rcs_information

Schema: company

Type: Query

Returns: CompanyRcsInformation

company_rcs_information: CompanyRcsInformation

company_settings

Schema: company

Type: Query

Returns: CompanySettings

company_settings: CompanySettings

company_tags

Schema: company

Type: Query

Returns: [Tag]

company_tags: [Tag]

company_webhooks

Schema: company

Type: Query

Returns: [CompanyWebhook]

company_webhooks: [CompanyWebhook]

current_company

Schema: company

Type: Query

Returns: Company

current_company: Company

current_user

Schema: user

Type: Query

Returns: User

current_user: User

current_user_settings

Schema: user

Type: Query

Returns: User

current_user_settings: User

dashboard_stats

Schema: user

Type: Query

Returns: UserDashboardStats

dashboard_stats: UserDashboardStats

document

Schema: user

Type: Query

Returns: Document

document(
  "The document id"
  id: Id!
): Document

documents

Schema: user

Type: Query

Returns: PaginatedDocuments

documents(
  "Cursor for the next page; pass back `pagination_info.next_cursor` from the previous response"
  cursor: String
  "Scope to a folder's contents, or with an explicit null to the repository root; omit for no folder filter"
  folder_id: Id
  "Limit number of results per page; defaults are applied if omitted"
  limit: Integer
  "Filter by file name"
  search: String
  "Filter by status; defaults to accepted"
  status: DocumentStatus
  "Filter to documents carrying any of these tag ids"
  tag_ids: [Id!]
): PaginatedDocuments

folders

Schema: user

Type: Query

Returns: FoldersPage

folders: FoldersPage

form_submission

Schema: company

Type: Query

Returns: FormInstance

form_submission(
  "The ID of the form"
  form_id: Id!
  "The ID of the form instance"
  form_instance_id: Id!
): FormInstance

form_submissions

Schema: company

Type: Query

Returns: PaginatedFormSubmissions

form_submissions(
  "Cursor for pagination"
  cursor: String
  "The ID of the form"
  form_id: Id!
  "Limit number of results"
  limit: Integer
): PaginatedFormSubmissions

global_search

Schema: user, company

Type: Query

Returns: [SearchResult!]!

global_search(
  "Maximum number of results per entity kind (user/company/group); defaults to 10"
  limit: Integer
  "Search term; at least 3 characters are required to return any results"
  query: String!
  "When true, include the viewer-visible subset of contact info (emails, phone numbers, addresses) on each row. Defaults to false."
  show_sensitive_data: Boolean
): [SearchResult!]!

group

Schema: user

Type: Query

Returns: Group

group(
  "Id of the group"
  id: Id!
): Group

group_notification_settings

Schema: user

Type: Query

Returns: GroupNotificationSettings

group_notification_settings(
  "The ID of the group user member record"
  group_user_member_id: Id!
): GroupNotificationSettings

groups

Schema: user

Type: Query

Returns: [Group]

groups(
  limit: Integer
  "Filter by metadata, e.g. {"key" => "value"}, only exact match is supported"
  metadata: Json
  "Filter by group name"
  name: String
): [Group]

interests

Schema: user

Type: Query

Returns: [Interest]

interests: [Interest]

notification

Schema: user, company

A single notification of the current actor's, by id.

Null when the id isn't the actor's — a caller can't tell "someone else's" from "gone", and doesn't need to.

Type: Query

Returns: Notification

notification(
  id: Id!
): Notification

notification_settings

Schema: user

Type: Query

Returns: UserNotificationSettings

notification_settings: UserNotificationSettings

notifications

Schema: user, company

Type: Query

Returns: PaginatedNotifications

notifications(
  "Cursor to get the next batch of results (null if none)"
  cursor: String
  "Limit number of results"
  limit: Integer
  "Filter to only read or unread notifications"
  status: NotificationStatus
): PaginatedNotifications

onboarding_status

Schema: user

Type: Query

Returns: OnboardingStatus

onboarding_status: OnboardingStatus

opt_out_requests

Schema: company

Type: Query

Returns: [OptOutRequest]

opt_out_requests(
  "Filter by the destination of the opt out request"
  destination: String
  "Filter by the external_id of the opt out request"
  external_id: String
  "Limit number of results"
  limit: Integer
  "Filter by the source of the opt out request"
  source: String
  "Filter by the status of the opt out request"
  status: OptOutRequestStatus
  "Filter by the timestamp of the opt out request"
  timestamp_after: NaiveDatetime
  "Filter by the timestamp of the opt out request"
  timestamp_before: NaiveDatetime
  "Filter by the type of the opt out request"
  type: OptOutRequestType
): [OptOutRequest]

organization_types

Schema: company

Type: Query

Returns: [OrganizationType]

organization_types: [OrganizationType]

paginated_b2b_connections

Schema: company

Type: Query

Returns: PaginatedB2bConnections

paginated_b2b_connections(
  "Cursor for the next page; pass back `pagination_info.next_cursor` from the previous response"
  cursor: String
  "Filter to one or more B2B connection types (any-of)"
  included_types: [B2bConnectionType!]
  "Fuzzy substring match on the other party's legal name; the calling company is never returned"
  legal_name: String
  "Limit number of results per page; defaults are applied if omitted"
  limit: Integer
): PaginatedB2bConnections

paginated_b2c_connections

Schema: user

Type: Query

Returns: PaginatedB2cConnections

paginated_b2c_connections(
  "Cursor for the next page; pass back `pagination_info.next_cursor` from the previous response"
  cursor: String
  "Filter to one or more B2C connection types (any-of)"
  included_types: [B2cConnectionType!]
  "Fuzzy substring match on the connected company's legal name"
  legal_name: String
  "Limit number of results per page; defaults are applied if omitted"
  limit: Integer
): PaginatedB2cConnections

paginated_b2c_connections_as_company

Schema: company

Type: Query

Returns: PaginatedB2cConnections

paginated_b2c_connections_as_company(
  "Cursor for the next page; pass back `pagination_info.next_cursor` from the previous response"
  cursor: String
  "Filter to one or more B2C connection types (any-of)"
  included_types: [B2cConnectionType!]
  "Limit number of results per page; defaults are applied if omitted"
  limit: Integer
  "Fuzzy substring match on the connected user's full name"
  user_name: String
): PaginatedB2cConnections

paginated_c2c_connections

Schema: user

Type: Query

Returns: PaginatedC2cConnections

paginated_c2c_connections(
  "Cursor for the next page; pass back `pagination_info.next_cursor` from the previous response"
  cursor: String
  "Filter to one or more C2C connection types (any-of)"
  included_types: [C2cConnectionType!]
  "Limit number of results per page; defaults are applied if omitted"
  limit: Integer
  "Fuzzy substring match on the other party's full name; the calling user is never returned"
  user_name: String
): PaginatedC2cConnections

paginated_client_secrets

Schema: company

Type: Query

Returns: PaginatedClientSecrets

paginated_client_secrets(
  "Cursor for the next page; pass back `pagination_info.next_cursor` from the previous response"
  cursor: String
  "Limit number of results per page; defaults are applied if omitted"
  limit: Integer
): PaginatedClientSecrets

paginated_company_invitation_links

Schema: company

Type: Query

Returns: PaginatedInvitationLinks

paginated_company_invitation_links(
  "Cursor for the next page; pass back `pagination_info.next_cursor` from the previous response"
  cursor: String
  "Limit number of results per page; defaults are applied if omitted"
  limit: Integer
): PaginatedInvitationLinks

paginated_form_versions

Schema: company

Type: Query

Returns: PaginatedCompanyFormVersions

paginated_form_versions(
  "Cursor for the next page; pass back `pagination_info.next_cursor` from the previous response"
  cursor: String
  "The ID of the form"
  form_id: Id!
  "Limit number of results per page; defaults are applied if omitted"
  limit: Integer
): PaginatedCompanyFormVersions

paginated_pending_b2b_connection_requests

Schema: company

Type: Query

Returns: PaginatedB2bConnectionRequests

paginated_pending_b2b_connection_requests(
  "Cursor for the next page; pass back `pagination_info.next_cursor` from the previous response"
  cursor: String
  "Filter by excluding the type of the connection request"
  excluded_type: B2bConnectionType
  "Filter by the type of the connection request"
  included_type: B2bConnectionType
  "Filter by invited company id"
  invited_company_id: Id
  "Limit number of results per page; defaults are applied if omitted"
  limit: Integer
): PaginatedB2bConnectionRequests

paginated_pending_b2c_connection_requests

Schema: company

Type: Query

Returns: PaginatedB2cConnectionRequests

paginated_pending_b2c_connection_requests(
  "Cursor for the next page; pass back `pagination_info.next_cursor` from the previous response"
  cursor: String
  "Filter by excluding the type of the connection request"
  excluded_type: B2cConnectionType
  "Filter by the type of the connection request"
  included_type: B2cConnectionType
  "Limit number of results per page; defaults are applied if omitted"
  limit: Integer
): PaginatedB2cConnectionRequests

paginated_pending_b2c_subscription_requests

Schema: user, company

Type: Query

Returns: PaginatedB2cSubscriptionRequests

paginated_pending_b2c_subscription_requests(
  "Cursor for the next page; pass back `pagination_info.next_cursor` from the previous response"
  cursor: String
  "Limit number of results per page; defaults are applied if omitted"
  limit: Integer
): PaginatedB2cSubscriptionRequests

paginated_pending_c2b_connection_requests

Schema: user

Type: Query

Returns: PaginatedC2bConnectionRequests

paginated_pending_c2b_connection_requests(
  "Cursor for the next page; pass back `pagination_info.next_cursor` from the previous response"
  cursor: String
  "Filter by excluding the type of the connection request"
  excluded_type: B2cConnectionType
  "Filter by the type of the connection request"
  included_type: B2cConnectionType
  "Limit number of results per page; defaults are applied if omitted"
  limit: Integer
): PaginatedC2bConnectionRequests

paginated_pending_c2c_connection_requests

Schema: user

Type: Query

Returns: PaginatedC2cConnectionRequests

paginated_pending_c2c_connection_requests(
  "Cursor for the next page; pass back `pagination_info.next_cursor` from the previous response"
  cursor: String
  "Filter by excluding the type of the connection request"
  excluded_type: C2cConnectionType
  "Filter by the type of the connection request"
  included_type: C2cConnectionType
  "Filter by invited user id"
  invited_user_id: Id
  "Limit number of results per page; defaults are applied if omitted"
  limit: Integer
): PaginatedC2cConnectionRequests

paginated_pending_group_user_member_invites

Schema: user

Type: Query

Returns: PaginatedGroupUserMemberInvites

paginated_pending_group_user_member_invites(
  "Cursor for the next page; pass back `pagination_info.next_cursor` from the previous response"
  cursor: String
  "Filter by group id"
  group_id: Id
  "Filter by invited user id"
  invited_user_id: Id
  "Limit number of results per page; defaults are applied if omitted"
  limit: Integer
): PaginatedGroupUserMemberInvites

paginated_pending_group_user_member_join_requests

Schema: user

Type: Query

Returns: PaginatedGroupUserMemberJoinRequests

paginated_pending_group_user_member_join_requests(
  "Cursor for the next page; pass back `pagination_info.next_cursor` from the previous response"
  cursor: String
  "Limit number of results per page; defaults are applied if omitted"
  limit: Integer
): PaginatedGroupUserMemberJoinRequests

paginated_received_b2b_connection_requests

Schema: company

Type: Query

Returns: PaginatedB2bConnectionRequests

paginated_received_b2b_connection_requests(
  "Cursor for the next page; pass back `pagination_info.next_cursor` from the previous response"
  cursor: String
  "Filter by excluding the type of the connection request"
  excluded_type: B2bConnectionType
  "Filter by the type of the connection request"
  included_type: B2bConnectionType
  "Filter by inviting company id - the one that invited you"
  inviting_company_id: Id
  "Limit number of results per page; defaults are applied if omitted"
  limit: Integer
): PaginatedB2bConnectionRequests

paginated_received_b2b_form_submission_requests

Schema: company

Type: Query

Returns: PaginatedReceivedB2bFormSubmissionRequests

paginated_received_b2b_form_submission_requests(
  "Cursor for the next page; pass back `pagination_info.next_cursor` from the previous response"
  cursor: String
  "Filter by form instance status"
  form_instance_status: FormBuilderFormInstanceStatus
  "Limit number of results per page; defaults are applied if omitted"
  limit: Integer
  "Search by company name or form title"
  search_query: String
): PaginatedReceivedB2bFormSubmissionRequests

paginated_received_b2c_connection_requests

Schema: user

Type: Query

Returns: PaginatedB2cConnectionRequests

paginated_received_b2c_connection_requests(
  "Cursor for the next page; pass back `pagination_info.next_cursor` from the previous response"
  cursor: String
  "Filter by excluding the type of the connection request"
  excluded_type: B2cConnectionType
  "Filter by the type of the connection request"
  included_type: B2cConnectionType
  "Limit number of results per page; defaults are applied if omitted"
  limit: Integer
): PaginatedB2cConnectionRequests

paginated_received_c2b_connection_requests

Schema: company

Type: Query

Returns: PaginatedC2bConnectionRequests

paginated_received_c2b_connection_requests(
  "Cursor for the next page; pass back `pagination_info.next_cursor` from the previous response"
  cursor: String
  "Filter by excluding the type of the connection request"
  excluded_type: B2cConnectionType
  "Filter by the type of the connection request"
  included_type: B2cConnectionType
  "Limit number of results per page; defaults are applied if omitted"
  limit: Integer
  "Filter by inviter user id"
  user_id: Id
): PaginatedC2bConnectionRequests

paginated_received_c2c_connection_requests

Schema: user

Type: Query

Returns: PaginatedC2cConnectionRequests

paginated_received_c2c_connection_requests(
  "Cursor for the next page; pass back `pagination_info.next_cursor` from the previous response"
  cursor: String
  "Filter by excluding the type of the connection request"
  excluded_type: C2cConnectionType
  "Filter by the type of the connection request"
  included_type: C2cConnectionType
  "Filter by inviting user id - the one that invited you"
  inviting_user_id: Id
  "Limit number of results per page; defaults are applied if omitted"
  limit: Integer
): PaginatedC2cConnectionRequests

paginated_received_form_submission_requests

Schema: user

Type: Query

Returns: PaginatedReceivedB2cFormSubmissionRequests

paginated_received_form_submission_requests(
  "Cursor for the next page; pass back `pagination_info.next_cursor` from the previous response"
  cursor: String
  "Filter by form instance status"
  form_instance_status: FormBuilderFormInstanceStatus
  "Limit number of results per page; defaults are applied if omitted"
  limit: Integer
  "Search by company name or form title"
  search_query: String
): PaginatedReceivedB2cFormSubmissionRequests

paginated_received_group_user_member_invites

Schema: user

Type: Query

Returns: PaginatedGroupUserMemberInvites

paginated_received_group_user_member_invites(
  "Cursor for the next page; pass back `pagination_info.next_cursor` from the previous response"
  cursor: String
  "Filter by inviting user id - the one that invited you"
  inviting_user_id: Id
  "Limit number of results per page; defaults are applied if omitted"
  limit: Integer
): PaginatedGroupUserMemberInvites

paginated_received_group_user_member_join_requests

Schema: user

Type: Query

Returns: PaginatedGroupUserMemberJoinRequests

paginated_received_group_user_member_join_requests(
  "Cursor for the next page; pass back `pagination_info.next_cursor` from the previous response"
  cursor: String
  "Id of the Group"
  group_id: Id!
  "Limit number of results per page; defaults are applied if omitted"
  limit: Integer
): PaginatedGroupUserMemberJoinRequests

paginated_sentiment_analysis_results

Schema: company

Type: Query

Returns: PaginatedSentimentAnalysisResults

paginated_sentiment_analysis_results(
  "Cursor for the next page; pass back `pagination_info.next_cursor` from the previous response"
  cursor: String
  "Filter by host address"
  host_address: String
  "Limit number of results per page; defaults are applied if omitted"
  limit: Integer
  "Filter by remote address"
  remote_address: String
  "Filter by timestamp from"
  timestamp_from: NaiveDatetime
  "Filter by timestamp to"
  timestamp_to: NaiveDatetime
  "Filter by communication type"
  type: ExternalCommunicationType
): PaginatedSentimentAnalysisResults

paginated_spam_reports

Schema: user

Type: Query

Returns: PaginatedSpamReports

paginated_spam_reports(
  "Filter by the channel type of the spam report"
  channel_type: SpamReportChannelType
  "Cursor for the next page; pass back `pagination_info.next_cursor` from the previous response"
  cursor: String
  "Filter by excluding the status of the spam report"
  excluded_status: SpamReportStatus
  "Filter by the status of the spam report"
  included_status: SpamReportStatus
  "Filter by the issue type of the spam report"
  issue_type: SpamReportIssueType
  "Limit number of results per page; defaults are applied if omitted"
  limit: Integer
): PaginatedSpamReports

paginated_user_groups

Schema: user

Type: Query

Returns: PaginatedGroupUserMembers

paginated_user_groups(
  "Cursor for the next page; pass back `pagination_info.next_cursor` from the previous response"
  cursor: String
  "Limit number of results per page; defaults are applied if omitted"
  limit: Integer
): PaginatedGroupUserMembers

pending_action_counts (company)

Schema: company

Type: Query

Returns: CompanyPendingActionCounts

pending_action_counts: CompanyPendingActionCounts

pending_action_counts (user)

Schema: user

Type: Query

Returns: UserPendingActionCounts

pending_action_counts: UserPendingActionCounts

pending_b2b_connection_requests

Schema: company

Type: Query

Returns: [B2bConnectionRequest]

pending_b2b_connection_requests(
  "Filter by excluding the type of the connection request"
  excluded_type: B2bConnectionType
  "Filter by the type of the connection request"
  included_type: B2bConnectionType
  "Filter by invited company id"
  invited_company_id: Id
  "Limit number of results"
  limit: Integer
): [B2bConnectionRequest]

pending_b2c_connection_requests

Schema: company

Type: Query

Returns: [B2cConnectionRequest]

pending_b2c_connection_requests(
  "Filter by excluding the type of the connection request"
  excluded_type: B2cConnectionType
  "Filter by the type of the connection request"
  included_type: B2cConnectionType
  "Filter by invited user id"
  invited_user_id: Id
  "Limit number of results"
  limit: Integer
): [B2cConnectionRequest]

pending_b2c_subscription_requests

Schema: user, company

Type: Query

Returns: [B2cSubscriptionRequest]

pending_b2c_subscription_requests: [B2cSubscriptionRequest]

pending_c2b_connection_requests

Schema: user

Type: Query

Returns: [C2bConnectionRequest]

pending_c2b_connection_requests(
  "Filter by excluding the type of the connection request"
  excluded_type: B2cConnectionType
  "Filter by the type of the connection request"
  included_type: B2cConnectionType
  "Limit number of results"
  limit: Integer
): [C2bConnectionRequest]

pending_c2c_connection_requests

Schema: user

Type: Query

Returns: [C2cConnectionRequest]

pending_c2c_connection_requests(
  "Filter by excluding the type of the connection request"
  excluded_type: C2cConnectionType
  "Filter by the type of the connection request"
  included_type: C2cConnectionType
  "Filter by invited user id"
  invited_user_id: Id
  "Limit number of results"
  limit: Integer
): [C2cConnectionRequest]

pending_group_user_member_invites

Schema: user

Type: Query

Returns: [GroupUserMemberInvite]

pending_group_user_member_invites(
  "Filter by group id"
  group_id: Id
  "Filter by invited user id"
  invited_user_id: Id
  "Limit number of results"
  limit: Integer
): [GroupUserMemberInvite]

pending_group_user_member_join_requests

Schema: user

Type: Query

Returns: [GroupUserMemberJoinRequest]

pending_group_user_member_join_requests(
  "Limit number of results"
  limit: Integer
): [GroupUserMemberJoinRequest]

received_b2b_connection_requests

Schema: company

Type: Query

Returns: [B2bConnectionRequest]

received_b2b_connection_requests(
  "Filter by excluding the type of the connection request"
  excluded_type: B2bConnectionType
  "Filter by the type of the connection request"
  included_type: B2bConnectionType
  "Filter by inviting company id - the one that invited you"
  inviting_company_id: Id
  "Limit number of results"
  limit: Integer
): [B2bConnectionRequest]

received_b2b_form_submission_requests

Schema: company

Type: Query

Returns: PaginatedB2bFormSubmissionRequests

received_b2b_form_submission_requests(
  "Filter by form instance status"
  form_instance_status: FormBuilderFormInstanceStatus
  "Limit number of results per page"
  limit: Integer
  "Page number"
  page: Integer
  "Search by company name or form title"
  search_query: String
): PaginatedB2bFormSubmissionRequests

received_b2c_connection_requests

Schema: user

Type: Query

Returns: [B2cConnectionRequest]

received_b2c_connection_requests(
  "Filter by excluding the type of the connection request"
  excluded_type: B2cConnectionType
  "Filter by the type of the connection request"
  included_type: B2cConnectionType
  "Limit number of results"
  limit: Integer
): [B2cConnectionRequest]

received_c2b_connection_requests

Schema: company

Type: Query

Returns: [C2bConnectionRequest]

received_c2b_connection_requests(
  "Filter by excluding the type of the connection request"
  excluded_type: B2cConnectionType
  "Filter by the type of the connection request"
  included_type: B2cConnectionType
  "Limit number of results"
  limit: Integer
  "Filter by inviter user id"
  user_id: Id
): [C2bConnectionRequest]

received_c2c_connection_requests

Schema: user

Type: Query

Returns: [C2cConnectionRequest]

received_c2c_connection_requests(
  "Filter by excluding the type of the connection request"
  excluded_type: C2cConnectionType
  "Filter by the type of the connection request"
  included_type: C2cConnectionType
  "Filter by inviting user id - the one that invited you"
  inviting_user_id: Id
  "Limit number of results"
  limit: Integer
): [C2cConnectionRequest]

received_form_submission_requests

Schema: user

Type: Query

Returns: PaginatedB2cFormSubmissionRequests

received_form_submission_requests(
  "Filter by form instance status"
  form_instance_status: FormBuilderFormInstanceStatus
  "Limit number of results per page"
  limit: Integer
  "Page number"
  page: Integer
  "Search by company name or form title"
  search_query: String
): PaginatedB2cFormSubmissionRequests

received_group_user_member_invites

Schema: user

Type: Query

Returns: [GroupUserMemberInvite]

received_group_user_member_invites(
  "Filter by inviting user id - the one that invited you"
  inviting_user_id: Id
  "Limit number of results"
  limit: Integer
): [GroupUserMemberInvite]

received_group_user_member_join_requests

Schema: user

Type: Query

Returns: [GroupUserMemberJoinRequest]

received_group_user_member_join_requests(
  "Id of the Group"
  group_id: Id!
  "Limit number of results"
  limit: Integer
): [GroupUserMemberJoinRequest]

recent_notifications

Schema: user, company

Type: Query

Returns: [Notification!]!

recent_notifications(
  "Maximum number of records to return (default 5)"
  limit: Integer
): [Notification!]!

sent_b2b_form_submission_requests

Schema: company

Type: Query

Returns: PaginatedSentB2bFormSubmissionRequests

sent_b2b_form_submission_requests(
  "Cursor for pagination"
  cursor: String
  "The ID of the form"
  form_id: Id!
  "Limit number of results"
  limit: Integer
): PaginatedSentB2bFormSubmissionRequests

sent_b2c_form_submission_requests

Schema: company

Type: Query

Returns: PaginatedSentB2cFormSubmissionRequests

sent_b2c_form_submission_requests(
  "Cursor for pagination"
  cursor: String
  "The ID of the form"
  form_id: Id!
  "Limit number of results"
  limit: Integer
): PaginatedSentB2cFormSubmissionRequests

sentiment_analysis_result

Schema: company

Type: Query

Returns: SentimentAnalysisReport

sentiment_analysis_result(
  "The ID of the sentiment analysis report"
  id: Id!
): SentimentAnalysisReport

sentiment_analysis_results

Schema: company

Type: Query

Returns: PaginatedSentimentAnalysisReports

sentiment_analysis_results(
  "Filter by host address"
  host_address: String
  "Limit number of results per page"
  limit: Integer
  "Page number"
  page: Integer
  "Filter by remote address"
  remote_address: String
  "Filter by timestamp from"
  timestamp_from: NaiveDatetime
  "Filter by timestamp to"
  timestamp_to: NaiveDatetime
  "Filter by communication type"
  type: ExternalCommunicationType
): PaginatedSentimentAnalysisReports

spam_reports

Schema: user

Type: Query

Returns: [SpamReport]

spam_reports(
  "Filter by the channel type of the spam report"
  channel_type: SpamReportChannelType
  "Filter by excluding the status of the spam report"
  excluded_status: SpamReportStatus
  "Filter by the status of the spam report"
  included_status: SpamReportStatus
  "Filter by the issue type of the spam report"
  issue_type: SpamReportIssueType
  "Limit number of results"
  limit: Integer
): [SpamReport]

specialties

Schema: user, company

Type: Query

Returns: [Specialty]

specialties: [Specialty]

switchable_companies

Schema: user, company

Type: Query

Returns: [ShallowCompany]

switchable_companies(
  "Limit number of results (defaults to 20)"
  limit: Integer
  "Fuzzy substring match by legal name"
  search: String
): [ShallowCompany]

tags

Schema: user

Type: Query

Returns: [Tag]

tags: [Tag]

ten_dlc_api_key_authorizations

Schema: company

Type: Query

Returns: [TenDlcApiKeyAuthorization]

ten_dlc_api_key_authorizations: [TenDlcApiKeyAuthorization]

ten_dlc_api_keys

Schema: company

Type: Query

Returns: [TenDlcApiKey]

ten_dlc_api_keys(
  "Filter by key type (owned or authorized), optional"
  api_key_type: TenDlcApiKeyType
): [TenDlcApiKey]

ten_dlc_brand

Schema: company

Type: Query

Returns: TenDlcBrand

ten_dlc_brand(
  "Internal brand identifier (UUID)"
  id: Id!
): TenDlcBrand

ten_dlc_brands

Schema: company

Type: Query

Returns: PaginatedTenDlcBrands

ten_dlc_brands(
  "Filter by TCR Brand ID (e.g., B123456)"
  brand_id: String
  "Filter by company_id"
  company_id: Id
  "Filter by ownership type"
  ownership_type: TenDlcOwnershipType
  "Page number"
  page: Integer
  "Page size"
  page_size: Integer
  "Filter by status"
  status: TenDlcBrandStatus
  "Filter by workflow status"
  workflow_status: TenDlcBrandWorkflowStatus
): PaginatedTenDlcBrands

ten_dlc_campaign

Schema: company

Type: Query

Returns: TenDlcCampaign

ten_dlc_campaign(
  "Internal campaign identifier (UUID)"
  id: Id!
): TenDlcCampaign

ten_dlc_campaign_with_telephone_numbers

Schema: company

Type: Query

Returns: TenDlcCampaignWithTelephoneNumbers

ten_dlc_campaign_with_telephone_numbers(
  "Internal campaign identifier (UUID)"
  id: Id!
): TenDlcCampaignWithTelephoneNumbers

ten_dlc_campaigns

Schema: company

Type: Query

Returns: PaginatedTenDlcCampaigns

ten_dlc_campaigns(
  "Filter by TCR Brand ID (e.g., B123456)"
  brand_id: String
  "Filter by TCR Campaign ID (e.g., C123456)"
  campaign_id: String
  "Filter by company_id"
  company_id: Id
  "Filter by ownership type: direct = owned by the company, partner = shared by a partner company"
  ownership_type: TenDlcOwnershipType
  "Page number"
  page: Integer
  "Page size"
  page_size: Integer
  "Filter by status"
  status: TenDlcCampaignStatus
  "Filter by usecase"
  usecase: String
  "Filter by vertical"
  vertical: String
  "Filter by workflow status"
  workflow_status: TenDlcCampaignWorkflowStatus
): PaginatedTenDlcCampaigns

unread_notification_count

Schema: user, company

Type: Query

Returns: Integer

unread_notification_count: Integer

user

Schema: user, company

Type: Query

Returns: User

user(
  "The ID of the user to retrieve"
  id: Id!
): User

user_by_username

Schema: user, company

Type: Query

Returns: User

user_by_username(
  "The username of the user to retrieve"
  username: String!
): User

user_events

Schema: user

Type: Query

Returns: PaginatedUserEvents

user_events(
  "Cursor for the next page; pass back `pagination_info.next_cursor` from the previous response"
  cursor: String
  "Event token minted by the partner company's backend for the calling user"
  event_token: String!
  "Limit number of results per page; defaults are applied if omitted"
  limit: Integer
  "Only events that occurred at or after this time"
  occurred_from: Datetime
  "Only events that occurred before this time"
  occurred_to: Datetime
  "Only events whose type starts with this; must start with the company's prefix (defaults to all of its events)"
  type_prefix: String
): PaginatedUserEvents

user_group_members

Schema: user

Type: Query

Returns: GroupUserMemberList

user_group_members(
  "Cursor to get the next batch of results (null if none)"
  cursor: String
  "The ID of the group to list members for"
  group_id: Id!
  "Number of records to return (max. 50)"
  limit: Integer
): GroupUserMemberList

user_groups

Schema: user

Type: Query

Returns: [GroupUserMember]

user_groups(
  "Limit number of results"
  limit: Integer
): [GroupUserMember]

user_import

Schema: company

Type: Query

Returns: UserImport

user_import(
  "The ID of the user import"
  id: Id!
): UserImport

user_imports

Schema: company

Type: Query

Returns: PaginatedUserImports

user_imports(
  "Cursor to get the next batch of results (null if none)"
  cursor: String
  "Limit number of results"
  limit: Integer
): PaginatedUserImports

users

Schema: user, company

Type: Query

Returns: [User]

users(
  email: String
  limit: Integer
  "Filter by metadata, e.g. {"key" => "value"}, only exact match is supported"
  metadata: Json
  "Filter by username or full name"
  name: String
  telephone_number: String
): [User]

vertical_types

Schema: user, company

Type: Query

Returns: [VerticalType]

vertical_types: [VerticalType]