> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sendbaze.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List consents

> Every consent your organisation recorded, newest first, revoked ones included. `value` answers a regulator's question about one person. Requires `read`.



## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/consents
openapi: 3.1.0
info:
  title: Sendbaze API
  version: '1.0'
  description: >
    Transactional email and SMS for Africa. Send from your own domain through
    Amazon SES in Cape Town.

    Every send returns an id immediately; delivery is reported by webhook and in
    the dashboard logs.
  contact:
    name: Sendbaze support
    email: support@sendbaze.com
    url: https://www.sendbaze.com
servers:
  - url: https://api.sendbaze.com
security:
  - bearerAuth: []
tags:
  - name: Emails
  - name: Templates
  - name: Domains
  - name: Suppressions
  - name: Webhooks
  - name: SMS
  - name: Contacts
  - name: Senders
  - name: Usage
paths:
  /v1/consents:
    get:
      tags:
        - Contacts
      summary: List consents
      description: >-
        Every consent your organisation recorded, newest first, revoked ones
        included. `value` answers a regulator's question about one person.
        Requires `read`.
      operationId: listConsents
      parameters:
        - $ref: '#/components/parameters/ConsentValue'
        - $ref: '#/components/parameters/ConsentContactId'
        - $ref: '#/components/parameters/ConsentChannel'
        - $ref: '#/components/parameters/ConsentActive'
        - name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 500
            default: 50
        - $ref: '#/components/parameters/Cursor'
      responses:
        '200':
          description: A page of consents
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                  - nextCursor
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Consent'
                  nextCursor:
                    type:
                      - string
                      - 'null'
components:
  parameters:
    ConsentValue:
      name: value
      in: query
      description: Exact email address or E.164 number (URL-encode the plus sign as %2B).
      schema:
        type: string
        maxLength: 254
    ConsentContactId:
      name: contactId
      in: query
      schema:
        type: string
    ConsentChannel:
      name: channel
      in: query
      schema:
        type: string
        enum:
          - email
          - sms
    ConsentActive:
      name: active
      in: query
      description: true returns unrevoked rows only.
      schema:
        type: boolean
    Cursor:
      name: cursor
      in: query
      description: The `nextCursor` of the previous page.
      schema:
        type: string
  schemas:
    Consent:
      type: object
      required:
        - id
        - contactId
        - channel
        - value
        - purpose
        - source
        - evidence
        - capturedAt
        - recordedAt
        - revokedAt
        - revokedReason
      properties:
        id:
          type: string
          example: cns_01j9x7k2r4m8q3v5n6b7c8d9e0
        contactId:
          type:
            - string
            - 'null'
          description: Null once the contact was deleted; `value` stays as the evidence.
        channel:
          $ref: '#/components/schemas/ConsentChannel'
        value:
          type: string
          description: The address or number consent was given for
          as it was when recorded.: null
        purpose:
          type: string
          example: marketing
        source:
          $ref: '#/components/schemas/ConsentSource'
        evidence:
          type:
            - object
            - 'null'
          additionalProperties: true
        capturedAt:
          type: string
          format: date-time
          description: When the person consented.
        recordedAt:
          type: string
          format: date-time
          description: When Sendbaze stored it.
        revokedAt:
          type:
            - string
            - 'null'
          format: date-time
        revokedReason:
          type:
            - string
            - 'null'
          description: stop_reply
          unsubscribe: null
          manual or api.: null
    ConsentChannel:
      type: string
      enum:
        - email
        - sms
    ConsentSource:
      type: string
      enum:
        - form
        - import
        - existing_customer
        - manual
        - attestation
      description: >
        How the person agreed. form: a form they submitted. import: a list you
        brought with consent already

        obtained. existing_customer: they bought from you and could opt out
        (POPIA s69(3)). manual: a teammate

        typed it in. attestation: written by the dashboard when a teammate
        confirms a list's consent on the Send page.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        An API key from the dashboard. `sk_live_…` sends; `sk_test_…` validates
        and returns ids without sending.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.