Kinde Subscribers API

openapi: 3.0.0
info:
  version: '1'
  title: Kinde Account API Keys Subscribers API
  description: '

    Provides endpoints to operate on an authenticated user.


    ## Intro


    ## How to use


    1. Get a user access token - this can be obtained when a user signs in via the methods you''ve setup in Kinde (e.g. Google, passwordless, etc).


    2. Call one of the endpoints below using the user access token in the Authorization header as a Bearer token. Typically, you can use the `getToken` command in the relevant SDK.

    '
  termsOfService: https://docs.kinde.com/trust-center/agreements/terms-of-service/
  contact:
    name: Kinde Support Team
    email: support@kinde.com
    url: https://docs.kinde.com
tags:
- name: Subscribers
  x-displayName: Subscribers
paths:
  /api/v1/subscribers:
    servers: []
    get:
      tags:
      - Subscribers
      operationId: GetSubscribers
      x-scope: read:subscribers
      description: "The returned list can be sorted by full name or email address\nin ascending or descending order. The number of records to return at a time can also be controlled using the `page_size` query\nstring parameter.\n\n<div>\n  <code>read:subscribers</code>\n</div>\n"
      summary: List Subscribers
      parameters:
      - name: sort
        in: query
        description: Field and order to sort the result by.
        schema:
          type: string
          nullable: true
          enum:
          - name_asc
          - name_desc
          - email_asc
          - email_desc
      - name: page_size
        in: query
        description: Number of results per page. Defaults to 10 if parameter not sent.
        schema:
          type: integer
          nullable: true
      - name: next_token
        in: query
        description: A string to get the next page of results if there are more results.
        schema:
          type: string
          nullable: true
      responses:
        '200':
          description: Subscriber successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/get_subscribers_response'
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/get_subscribers_response'
        '403':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/error_response'
        '429':
          description: Request was throttled.
      security:
      - kindeBearerAuth: []
    post:
      tags:
      - Subscribers
      operationId: CreateSubscriber
      x-scope: create:subscribers
      description: "Create subscriber.\n\n<div>\n  <code>create:subscribers</code>\n</div>\n"
      summary: Create Subscriber
      parameters:
      - name: first_name
        in: query
        description: Subscriber's first name.
        required: true
        schema:
          type: string
          nullable: false
      - name: last_name
        in: query
        description: Subscriber's last name.
        required: true
        schema:
          type: string
          nullable: true
      - name: email
        in: query
        description: The email address of the subscriber.
        required: true
        schema:
          type: string
          nullable: true
      responses:
        '201':
          description: Subscriber successfully created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/create_subscriber_success_response'
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/create_subscriber_success_response'
        '400':
          description: Invalid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/error_response'
        '403':
          description: Invalid credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/error_response'
        '429':
          description: Request was throttled.
      security:
      - kindeBearerAuth: []
  /api/v1/subscribers/{subscriber_id}:
    servers: []
    get:
      tags:
      - Subscribers
      operationId: GetSubscriber
      x-scope: read:subscribers
      description: "Retrieve a subscriber record.\n\n<div>\n  <code>read:subscribers</code>\n</div>\n"
      summary: Get Subscriber
      parameters:
      - name: subscriber_id
        in: path
        description: The subscriber's id.
        required: true
        schema:
          type: string
          nullable: false
      responses:
        '200':
          description: Subscriber successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/get_subscriber_response'
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/get_subscriber_response'
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/error_response'
        '403':
          description: Invalid credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/error_response'
        '429':
          description: Request was throttled.
      security:
      - kindeBearerAuth: []
components:
  schemas:
    get_subscribers_response:
      type: object
      properties:
        code:
          type: string
          description: Response code.
        message:
          type: string
          description: Response message.
        subscribers:
          type: array
          items:
            $ref: '#/components/schemas/subscribers_subscriber'
        next_token:
          description: Pagination token.
          type: string
    error:
      type: object
      properties:
        code:
          type: string
          description: Error code.
        message:
          type: string
          description: Error message.
    subscribers_subscriber:
      type: object
      properties:
        id:
          type: string
        email:
          type: string
        full_name:
          type: string
        first_name:
          type: string
        last_name:
          type: string
    get_subscriber_response:
      type: object
      properties:
        code:
          type: string
          description: Response code.
        message:
          type: string
          description: Response message.
        subscribers:
          type: array
          items:
            $ref: '#/components/schemas/subscriber'
    create_subscriber_success_response:
      type: object
      properties:
        subscriber:
          type: object
          properties:
            subscriber_id:
              type: string
              description: A unique identifier for the subscriber.
    error_response:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/error'
    subscriber:
      type: object
      properties:
        id:
          type: string
        preferred_email:
          type: string
        first_name:
          type: string
        last_name:
          type: string
  securitySchemes:
    kindeBearerAuth:
      description: 'To access these endpoints, you will need to use a user token. This can be obtained when your users sign in via the methods you''ve setup in Kinde (e.g. Google, passwordless, etc). Find this using the getToken command in the relevant SDK.

        '
      type: http
      scheme: bearer
      bearerFormat: JWT