API guide
Data Sharing API
Data Sharing API manages anonymized sharing preferences and user controls.
Path: /api/v1/data-sharing
Format: AI-first docs
Info
Contract-backed page
This page is generated from the current OpenAPI contract summary so docs stay aligned with the formal API surface.
GET /api/v1/data-sharing
Get data sharing preferences
Required scopes
read:data_sharing
Request
- no extra request parameters
Responses
- 200: OK
- 401:
- 403:
- 429:
- 500:
Errors
none documented
Examples
Code sample (curl)
1
curl "https://api.profileclaw.com/api/v1/data-sharing" -H "Authorization: Bearer $PROFILECLAW_API_KEY"PUT /api/v1/data-sharing
Update data sharing preferences
At least one boolean preference must be provided. Unspecified fields keep their previous value.
Required scopes
write:data_sharing
Request
- request body available
Responses
- 200: OK
- 400: Bad request
- 401:
- 403:
- 429:
- 500:
Errors
data_sharing.no_preferences_provided
Examples
Code sample (curl)
1
curl -X PUT "https://api.profileclaw.com/api/v1/data-sharing" -H "Authorization: Bearer $PROFILECLAW_API_KEY" -H "Content-Type: application/json" -d '{"shareAssessmentResults":true}'Related surfaces
Use these surfaces when you need deeper inspection or automation.