End Users

List End Users

List all end users (ie: users who interact with your Kapa bot) for a project.

get/query/v1/projects/{project_id}/end-users/

Request

  • Base URL: https://api.kapa.ai
  • URL: https://api.kapa.ai/query/v1/projects/{project_id}/end-users/
  • Auth: one of:
    • API key in cookie sessionid
    • HTTP bearer
    • API key in header X-API-KEY

Path parameters

project_idstring required

The ID of the project.

Query parameters

has_emailboolean

Filter users based on whether or not they have an email address.

orderingstring

Which field to use when ordering the results.

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

searchstring

A search term.

Response

countinteger required

The total number of items in the collection.

nextstring uri nullable

A link to the next page of items, or null if there is no next page.

previousstring uri nullable

A link to the previous page of items, or null if this is the first page.

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}

Changes

No recorded changes to this operation across all 1 revision of this API.