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

List Opt-Out Requests

GraphQL endpoint: /company

List all opt-out requests received by the authenticated company. Opt-out requests are created when users request to stop receiving communications.

Optional filters:

  • type: Filter by type (SMS, VOICE, EMAIL)

  • status: Filter by status (PENDING, ACCEPTED, REJECTED)

  • source: Filter by source/sender

  • destination: Filter by destination/recipient

  • externalId: Filter by external identifier

  • timestampBefore: Filter by timestamp

  • timestampAfter: Filter by timestamp

  • limit: Maximum number of results

Returns opt-out requests with associated user information (if available).

Query

query (
  $type: OptOutRequestType
  $status: OptOutRequestStatus
  $source: String
  $destination: String
  $externalId: String
  $timestampBefore: NaiveDateTime
  $timestampAfter: NaiveDateTime
  $limit: Int
) {
  optOutRequests (
    type: $type
    status: $status
    source: $source
    destination: $destination
    externalId: $externalId
    timestampBefore: $timestampBefore
    timestampAfter: $timestampAfter
    limit: $limit
  ) {
    id
    source
    destination
    externalId
    messageBody
    type
    status
    createdAt
    updatedAt
    timestamp
    metadata
    company {
      id
      legalName
      brandName
      profileName
      yearFounded
      aboutUs
      metadata
      verified
      logoUrl
      verticalType {
        id
        displayName
        description
      }
      organizationType {
        id
        displayName
      }
      addresses {
        city
        country
        state
        street
        types
        zipCode
      }
      emails {
        email
      }
      telephoneNumbers {
        number
      }
      socialNetworks {
        type
        url
      }
      webpages {
        type
        url
      }
      specialties {
        description
        title
      }
      subscriptionTopics {
        id
        name
      }
    }
    user {
      id
      username
      firstName
      middleName
      lastName
      birthdate
      aboutMe
      timezone
      metadata
      addresses {
        city
        country
        state
        street
        types
        zipCode
      }
      emails {
        email
      }
      telephoneNumbers {
        number
      }
      socialNetworks {
        type
        url
      }
      webpages {
        type
        url
      }
      interests {
        description
        title
      }
    }
  }
}

Variables

Response

Previous008_opt_out
NextCreate Opt-Out Request

Last updated