List Active Subscribers

Returns a list of B2C subscriptions for the company including the subscription channel, and all the relevant details.

The company GraphQL API is accessible at /company

query (
	$userId: ID
	$includedTopic: B2cSubscriptionTopic
	$excludedTopic: B2cSubscriptionTopic
	$expirationDateBefore: Date
	$expirationDateAfter: Date
	$emailChannelEnabled: Boolean
	$smsChannelEnabled: Boolean
	$voiceChannelEnabled: Boolean
	$limit: Int
  ) {
	b2cSubscriptions (
  	userId: $userId
  	includedTopic: $includedTopic
  	excludedTopic: $excludedTopic
  	expirationDateBefore: $expirationDateBefore
  	expirationDateAfter: $expirationDateAfter
  	emailChannelEnabled: $emailChannelEnabled
  	smsChannelEnabled: $smsChannelEnabled
  	voiceChannelEnabled: $voiceChannelEnabled
  	limit: $limit
	) {
  	id
  	subscriptionTopics
  	shareInformationWithTheCompany
  	stopAllCommunications
  	expirationDate
  	notificationStartTime
  	notificationEndTime
  	timezone
  	insertedAt
  	updatedAt
  	company {
    	id
  	}
  	user {
    	id
  	}
  	email {
    	email
  	}
  	smsTelephoneNumber {
    	number
  	}
  	voiceTelephoneNumber {
    	number
  	}
	}
  }

Last updated

Was this helpful?