Crunch User Details API Documentation

Overview

Version information

Version : 0.0.1 [v.1]

Tags

  • UserDetailsController

Paths

Get User Details

GET /

Responses

HTTP Code Description Schema
200 User details successfully returned. UserDetails

Produces

  • application/json

Tags

  • UserDetailsController

Security

Type Name Scopes
Unknown oauth2-authorisation-code read:all

Example HTTP request

Request path
/

Example HTTP response

Response 200
{
  "email" : "john.doe@example.com",
  "firstName" : "John",
  "id" : "123456",
  "lastName" : "Doe"
}

Definitions

UserDetails

Name Description Schema
email
required
User’s email address
Example : "john.doe@example.com"
string
firstName
required
User’s first name
Example : "John"
string
id
required
A unique identifier associated to the user
Example : "123456"
string
lastName
required
User’s last name
Example : "Doe"
string