Sign Up

Users

Get the current user

GET
/me

Authorization

user_jwt write:project_api_keys
headerAuthorizationBearer <token>

Bearer access token for a signed-in user.

Scope: write:project_api_keys

Response Body

The user

application/json
  1. response

The signed-in user.

email*string

The user's email address.

id*string

The user ID.

Formatuuid
name?|

The user's display name, when set.

curl -X GET 'https://example.com/me'
{  "email": "string",  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string"}
GET
/me/privacy-policy

Reports whether the signed-in user has accepted the privacy policy version the platform currently requires.

Authorization

user_jwt
headerAuthorizationBearer <token>

Bearer access token for a signed-in user.

Response Body

The privacy policy status

application/json
  1. response

The signed-in user's standing against the required privacy policy.

accepted*boolean

Whether the user has accepted the required version. A client should prompt for consent only on an explicit false.

accepted_at?|

When the user last accepted a version; null if never.

Formatdate-time
accepted_version?|

The version the user last accepted, whatever version is required now.

url?|

Where the current policy text is published; null when no consent is required.

version?|

Version the platform currently requires; null when it requires no consent, in which case accepted is always true.

curl -X GET 'https://example.com/me/privacy-policy'
{  "accepted": true,  "accepted_at": "2019-08-24T14:15:22Z",  "accepted_version": "string",  "url": "string",  "version": "string"}
POST
/me/privacy-policy/accept

Records that the signed-in user accepts the named privacy policy version, which must be the version the platform currently requires. Accepting a version again only refreshes the acceptance time.

Authorization

user_jwt
headerAuthorizationBearer <token>

Bearer access token for a signed-in user.

Request Body

application/json
  1. body

The privacy policy version the user was shown and accepts. It must equal the version the platform requires now, so an acceptance of an older version is refused rather than recorded as consent to text the user never saw.

version*string

The policy version the user was shown and accepts.

Response Body

Privacy policy acceptance saved

curl -X POST 'https://example.com/me/privacy-policy/accept' \  -H 'Content-Type: application/json' \  -d '{  "version": "string"}'
Empty