Skip to navigation
BotBye APIPrivacyPrivacy

get end user privacy data

View as Markdown

Retrieves all privacy-related data for a specific end user identified by their server key and account ID. This endpoint provides granular access to individual end user data for compliance and transparency purposes.

Endpoint

GET {base_url}/api/v1/{account_id}/privacy/end-users/{server_key}/{end_user_account_id}

Required Variables

  • base_url: The base URL for the BotBye API
  • account_id: Your unique account identifier
  • server_key: The server key associated with the end user
  • end_user_account_id: The unique identifier for the specific end user

Authentication

Requires API key authentication via the api_key variable.

Response

Returns a JSON object containing all privacy-related data for the specified end user, including:

  • End user profile information
  • Behavioral data
  • Session information
  • Associated tracking data
  • Timestamps and metadata

Use Cases

  • Individual DSAR Requests: Respond to specific end user data access requests
  • User Data Portability: Export end user data for transfer to another service
  • Privacy Audits: Review data collected for specific users
  • Support Investigations: Access user data for troubleshooting or support cases

Notes

This endpoint requires both the server key and end user account ID to ensure proper authorization and data isolation between different end users.

Accepted permissions Account → Profile → Delete profile

Token scope Profile Action

Authentication

X-Api-Keystring

Personal access token. Create it in your BotBye account under Profile → Personal Access Tokens, tick the scopes the endpoints you call require (see each endpoint’s Token scope), and send the token in the X-Api-Key request header. A token works only for the account it was created in.

Path parameters

account_idstringRequired
server_keystringRequired
end_user_account_idstringRequired

Response headers

Content-Lengthinteger
ConnectionstringOptional

Response

get end user privacy data
serverKeystringformat: "uuid"
accountIdstring
activityobject or nullOptional