Crunch User Details API Documentation

user-details-api-service

Overview

Version information

Version : 0.0.1 [v.1]

Tags

  • UserDetailsController

Access

  • Base URL: https://public-api.crunch.co.uk/v1/user-details

Paths

Get User Details

Up
get /

Security

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

Return type

Example data

Content-Type: application/json
{
  "firstName" : "John",
  "lastName" : "Doe",
  "id" : "123456",
  "email" : "john.doe@example.com"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

User details successfully returned. UserDetails

Models

[ Jump to Methods ]

Table of Contents

  1. UserDetails

UserDetails Up

id
String A unique identifier associated to the user
example: 123456
email
String User's email address format: email
example: john.doe@example.com
firstName
String User's first name
example: John
lastName
String User's last name
example: Doe