Subscribers

List Subscribers

Changed on

The returned list can be sorted by full name or email address in ascending or descending order. The number of records to return at a time can also be controlled using the page_size query string parameter.

<div> <code>read:subscribers</code> </div>
get/api/v1/subscribers

Request

  • Base URL: https://your_kinde_subdomain.kinde.com
  • URL: https://your_kinde_subdomain.kinde.com/api/v1/subscribers
  • Auth: HTTP bearer

Query parameters

sort'name_asc' | 'name_desc' | 'email_asc' | 'email_desc' nullable

Field and order to sort the result by.

page_sizeinteger nullable

Number of results per page. Defaults to 10 if parameter not sent.

next_tokenstring nullable

A string to get the next page of results if there are more results.

Response

Subscriber successfully retrieved.

codestring

Response code.

messagestring

Response message.

next_tokenstring

Pagination token.

Changes

  • 0c5023c4d856Revision changes
    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

  • 2d09422a38e4Revision changes
    • breaking

      added the new required header request parameter Accept to all path's operations

    • info

      the endpoint scheme security kindeBearerAuth was added to the API

    • info

      the endpoint scheme security ManagementAPI was removed from the API