For the complete documentation index, see llms.txt. This page is also available as Markdown.

List B2C subscriptions (user)

GraphQL endpoint: /user

Lists the B2C subscriptions of the authenticated user. B2C subscriptions represent the user's consent to receive communications from companies via email, SMS, or voice. Results can be filtered by company, topic, expiration date, and subscription types, and are paginated with a limit and cursor. Each record includes topics and contact info.

Query

query (
  $userId: ID
  $companyId: ID
  $includedTopic: String
  $excludedTopic: String
  $expirationDateBefore: Date
  $expirationDateAfter: Date
  $types: [B2cSubscriptionType!]
  $limit: Int
  $cursor: String
) {
  b2cSubscriptions (
    userId: $userId
    companyId: $companyId
    includedTopic: $includedTopic
    excludedTopic: $excludedTopic
    expirationDateBefore: $expirationDateBefore
    expirationDateAfter: $expirationDateAfter
    types: $types
    limit: $limit
    cursor: $cursor
  ) {
    paginationInfo {
      limit
      nextCursor
    }

    records {
      ... on B2cEmailSubscription {
        id
        insertedAt
        updatedAt
        type
        subscriptionTopics
        expirationDate
        notificationStartTime
        notificationEndTime
        email
        company {
          id
        }
        user {
          id
        }
      }

      ... on B2cSmsSubscription {
        id
        insertedAt
        updatedAt
        type
        subscriptionTopics
        expirationDate
        notificationStartTime
        notificationEndTime
        telephoneNumber
        company {
          id
        }
        user {
          id
        }
      }

      ... on B2cVoiceSubscription {
        id
        insertedAt
        updatedAt
        type
        subscriptionTopics
        expirationDate
        notificationStartTime
        notificationEndTime
        telephoneNumber
        company {
          id
        }
        user {
          id
        }
      }
    }
  }
}

Variables

Response

Last updated