get customer privacy data | Botbye

{
  "profile": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Jane Doe",
    "avatarId": "9b2d7f4e-8c3a-4f1a-9d2b-1a2b3c4d5e6f",
    "createdAt": "1685600000000",
    "updatedAt": "1688200000000",
    "deletedAt": null
  },
  "auth": {
    "login": "janedoe123",
    "canonicalLogin": "janedoe123",
    "email": "jane.doe@example.com",
    "phone": "+14155552671",
    "hasPassword": true,
    "externalProviders": [
      "google",
      "facebook"
    ],
    "activeSessions": 2
  },
  "settings": {
    "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "locale": "en-US",
    "customerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "projects": [
    {
      "id": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
      "name": "Marketing Campaign",
      "serverKey": "4f5e6d7c-8b9a-0c1d-2e3f-4a5b6c7d8e9f",
      "siteKey": "9f8e7d6c-5b4a-3f2e-1d0c-9b8a7c6d5e4f",
      "createdAt": "1683000000000"
    }
  ],
  "accessTokens": [
    {
      "id": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
      "name": "Mobile App Token",
      "createdAt": "1684000000000",
      "expiresAt": "1715536000000"
    }
  ],
  "invitations": [
    {
      "email": "collaborator@example.com",
      "createdAt": "1686000000000",
      "status": "pending"
    }
  ],
  "contactValidationEvents": [
    {
      "email": "jane.doe@example.com",
      "subject": "Email Verification",
      "createdAt": "1685500000000"
    }
  ],
  "notifications": [
    {
      "id": "a1b2c3d4-e5f6-7a8b-9c0d-1e2f3a4b5c6d",
      "createdAt": "1687000000000"
    }
  ],
  "analytics": {
    "userActivityCount": 124,
    "userDataCount": 58
  }
}

Retrieves all privacy-related data associated with a customer account. This endpoint is used to fulfill data subject access requests (DSAR) and provide customers with a complete view of their stored personal information.

Endpoint

GET {base_url}/api/v1/{account_id}/privacy/data

Required Variables

base_url: The base URL for the BotBye API
account_id: Your unique account identifier

Authentication

Requires API key authentication via the api_key variable.

Response

Returns a comprehensive JSON object containing all privacy-related data for the customer, including:

Personal information
Account details
Activity logs
Associated metadata

Use Cases

GDPR/CCPA Compliance: Respond to data subject access requests
Data Auditing: Review what personal data is stored
Customer Transparency: Provide customers with their data upon request
Compliance Reporting: Generate reports for regulatory purposes

Example Response

The response includes structured data with customer information organized in a node-based format with edges for relationships.

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

Response headers

Content-Lengthinteger

ConnectionstringOptional

Response

get customer privacy data

profileobject

authobject

settingsobject or nullOptional

projectslist of objects or nullOptional

accessTokenslist of objects or nullOptional

invitationslist of objects or nullOptional

contactValidationEventslist of objects or nullOptional

notificationslist of objects or nullOptional

analyticsobject or nullOptional