GET /user/info

Get an authenticated user's resources

caution

Before you can get a Coil user's resources, they must grant your app permission to access their resources.

GET https://api.coil.com/user/info

Request headers

No encoded information is required in the body.

NameValue
Content-Typeapplication/x-www-form-urlencoded
Authorization BearerBearer access_token, where access_token is the JWT-format access token granted to your app through /oauth/token.

Example request

curl -X GET \
'https://api.coil.com/user/info' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-H 'Authorization: Bearer eyJhbGciOi...JSUzI1NfsQ' \
-d ''

Response parameters

The response is a JSON object containing Coil user resources.

ParameterTypeScopeDescription
emailstringemailThe user's email address, if authorized for the email scope.
substringsimple_wmThe user's unique and permanent ID.

Example response

{
"sub": "22028a7c-b720-7a3e-4387-6c9845f6201b",
"email": "[email protected]"
}

Next: Call POST /user/btp to generate a bilateral transfer protocol (BTP) token for the Coil user.