API reference Users
Retrieve the key owner
get/v1/me
Returns the user the API key belongs to. Useful for checking that a key works.
Responses
- 200
The user.
Fields of the 200 response of Retrieve the key owner Field Description objectstringAlways
"user".idstring (uuid)The user ID.
namestring | nulloptionalFull name.
emailstring (email) - 401
The API key is missing, invalid, revoked or expired. Error code:
unauthorized.Error body fields
Fields of the 401 error body of Retrieve the key owner Field Description errorobjecterror.codestringA stable, machine-readable error code.
One of
invalid_request,unauthorized,insufficient_scope,forbidden,not_found,conflict,rate_limited,internal_error.error.messagestringA description for people. The wording may change.
error.detailsobject[]optionalFor
invalid_request: the fields that failed validation.error.details[].fieldstringoptionalerror.details[].messagestringoptionalerror.request_idstring | nulloptionalQuote this when contacting support.
- 429
Rate limit exceeded. See the
Retry-Afterheader. Error code:rate_limited.Error body fields
Fields of the 429 error body of Retrieve the key owner Field Description errorobjecterror.codestringA stable, machine-readable error code.
One of
invalid_request,unauthorized,insufficient_scope,forbidden,not_found,conflict,rate_limited,internal_error.error.messagestringA description for people. The wording may change.
error.detailsobject[]optionalFor
invalid_request: the fields that failed validation.error.details[].fieldstringoptionalerror.details[].messagestringoptionalerror.request_idstring | nulloptionalQuote this when contacting support.
Any request can also fail with 500 internal_error. See Errors for every code.