Skip to main content
POST
/
v1
/
gdpr
/
requests
Create a GDPR request
curl --request POST \
  --url https://public-api.sessionboard.com/v1/gdpr/requests \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "requestType": "erasure",
  "identityType": "email",
  "identityValue": "<string>"
}
'
{
  "id": "<string>",
  "org_id": "<string>",
  "request_type": "<string>",
  "identity_type": "<string>",
  "identity_value": "<string>",
  "status": "<string>",
  "matching_user_exists": true,
  "response": {
    "users": [
      123
    ],
    "org_users": [
      "<string>"
    ],
    "event_users": [
      123
    ],
    "contact_records": [
      "<string>"
    ]
  },
  "created_at": "<string>",
  "updated_at": "<string>"
}

Authorizations

x-access-token
string
header
required

API key for authentication. Obtain from the Sessionboard admin dashboard.

Body

application/json
requestType
enum<string>
required

The type of GDPR request.

Available options:
erasure,
access
identityType
enum<string>
required

The type of identity to look up.

Available options:
email
identityValue
string
required

The identity value (e.g., an email address).

Response

Created

A GDPR data access or erasure request.

id
string
org_id
string
request_type
string
identity_type
string
identity_value
string
status
string
matching_user_exists
boolean
response
object
created_at
string
updated_at
string