Returns a paginated collection of Users

Query Parameters

page_size
integer
(int32)

Sets the number of items to return in paginated endpoints

page
integer
(int32)

Sets the page number for paginated endpoints

Response

200 Users
data
object[]

Resource Data

app_id
string

App ID

created
string
(date-time)

Creation timestamp

custom
object

Custom Data

details
object

User Details. This object will additionally contain properties from one of the following details models: EmailPassword, Custom, Facebook, Github, Google, LinkedIn, Instagram, Twitter

image
string
(url)

URL of a User Profile image

name
string

Full Name

social
object

Social Details

facebook
object

Facebook Details

email
string

E-mail address

full_name
string

Full Name

profile_picture
string
(url)

URL of the user’s profile picture

raw_data
object

Raw Response Data

github
object

Github Details

email
string

E-mail address

full_name
string

Full Name

profile_picture
string
(url)

URL of the user’s profile picture

raw_data
object

Raw Response Data

google
object

Google Details

email
string

E-mail address

full_name
string

Full Name

profile_picture
string
(url)

URL of the user’s profile picture

raw_data
object

Raw Response Data

instagram
object

Instagram Details

email
string

E-mail address

full_name
string

Full Name

profile_picture
string
(url)

URL of the user’s profile picture

raw_data
object

Raw Response Data

linkedin
object

LinkedIn Details

email
string

E-mail address

full_name
string

Full Name

profile_picture
string
(url)

URL of the user’s profile picture

raw_data
object

Raw Response Data

twitter
object

Twitter Details

email
string

E-mail address

full_name
string

Full Name

profile_picture
string
(url)

URL of the user’s profile picture

raw_data
object

Raw Response Data

uuid
string
(uuid)

User ID

meta
object

Response Metadata

request_id
string
(uuid)

Request Reference ID

status
integer
(int32)

HTTP Response Code

version
string
(semver)

API Version

Create a new User. This is only applicable for the Email/Password provider. Other providers will automatically generate the user upon a successful login.

Request Body

schema application/json
app_id
string

App ID

custom
object

Custom User Data

email
string
(email)

E-mail of the User

image
string
(url)

URL of a profile image

name
string

Full Name

password
string

A password to set for the User

username
string

Display username

Response

201 User
data
object

Resource Data

app_id
string

App ID

created
string
(date-time)

Creation timestamp

custom
object

Custom Data

details
object

User Details. This object will additionally contain properties from one of the following details models: EmailPassword, Custom, Facebook, Github, Google, LinkedIn, Instagram, Twitter

image
string
(url)

URL of a User Profile image

name
string

Full Name

social
object

Social Details

facebook
object

Facebook Details

email
string

E-mail address

full_name
string

Full Name

profile_picture
string
(url)

URL of the user’s profile picture

raw_data
object

Raw Response Data

github
object

Github Details

email
string

E-mail address

full_name
string

Full Name

profile_picture
string
(url)

URL of the user’s profile picture

raw_data
object

Raw Response Data

google
object

Google Details

email
string

E-mail address

full_name
string

Full Name

profile_picture
string
(url)

URL of the user’s profile picture

raw_data
object

Raw Response Data

instagram
object

Instagram Details

email
string

E-mail address

full_name
string

Full Name

profile_picture
string
(url)

URL of the user’s profile picture

raw_data
object

Raw Response Data

linkedin
object

LinkedIn Details

email
string

E-mail address

full_name
string

Full Name

profile_picture
string
(url)

URL of the user’s profile picture

raw_data
object

Raw Response Data

twitter
object

Twitter Details

email
string

E-mail address

full_name
string

Full Name

profile_picture
string
(url)

URL of the user’s profile picture

raw_data
object

Raw Response Data

uuid
string
(uuid)

User ID

meta
object

Response Metadata

request_id
string
(uuid)

Request Reference ID

status
integer
(int32)

HTTP Response Code

version
string
(semver)

API Version

Retrieve a User

Path Parameters

user_uuid
string
(uuid)

User ID

Response

200 User
data
object

Resource Data

app_id
string

App ID

created
string
(date-time)

Creation timestamp

custom
object

Custom Data

details
object

User Details. This object will additionally contain properties from one of the following details models: EmailPassword, Custom, Facebook, Github, Google, LinkedIn, Instagram, Twitter

image
string
(url)

URL of a User Profile image

name
string

Full Name

social
object

Social Details

facebook
object

Facebook Details

email
string

E-mail address

full_name
string

Full Name

profile_picture
string
(url)

URL of the user’s profile picture

raw_data
object

Raw Response Data

github
object

Github Details

email
string

E-mail address

full_name
string

Full Name

profile_picture
string
(url)

URL of the user’s profile picture

raw_data
object

Raw Response Data

google
object

Google Details

email
string

E-mail address

full_name
string

Full Name

profile_picture
string
(url)

URL of the user’s profile picture

raw_data
object

Raw Response Data

instagram
object

Instagram Details

email
string

E-mail address

full_name
string

Full Name

profile_picture
string
(url)

URL of the user’s profile picture

raw_data
object

Raw Response Data

linkedin
object

LinkedIn Details

email
string

E-mail address

full_name
string

Full Name

profile_picture
string
(url)

URL of the user’s profile picture

raw_data
object

Raw Response Data

twitter
object

Twitter Details

email
string

E-mail address

full_name
string

Full Name

profile_picture
string
(url)

URL of the user’s profile picture

raw_data
object

Raw Response Data

uuid
string
(uuid)

User ID

meta
object

Response Metadata

request_id
string
(uuid)

Request Reference ID

status
integer
(int32)

HTTP Response Code

version
string
(semver)

API Version

Path Parameters

user_uuid
string
(uuid)

User ID

Request Body

schema application/json
custom
object

Replace customdata

email
string
(email)

User’s email

image
string
(url)

URL of a profile image

name
string

Full Name

password
string

New password

username
string

Display username

Response

200 User
data
object

Resource Data

app_id
string

App ID

created
string
(date-time)

Creation timestamp

custom
object

Custom Data

details
object

User Details. This object will additionally contain properties from one of the following details models: EmailPassword, Custom, Facebook, Github, Google, LinkedIn, Instagram, Twitter

image
string
(url)

URL of a User Profile image

name
string

Full Name

social
object

Social Details

facebook
object

Facebook Details

email
string

E-mail address

full_name
string

Full Name

profile_picture
string
(url)

URL of the user’s profile picture

raw_data
object

Raw Response Data

github
object

Github Details

email
string

E-mail address

full_name
string

Full Name

profile_picture
string
(url)

URL of the user’s profile picture

raw_data
object

Raw Response Data

google
object

Google Details

email
string

E-mail address

full_name
string

Full Name

profile_picture
string
(url)

URL of the user’s profile picture

raw_data
object

Raw Response Data

instagram
object

Instagram Details

email
string

E-mail address

full_name
string

Full Name

profile_picture
string
(url)

URL of the user’s profile picture

raw_data
object

Raw Response Data

linkedin
object

LinkedIn Details

email
string

E-mail address

full_name
string

Full Name

profile_picture
string
(url)

URL of the user’s profile picture

raw_data
object

Raw Response Data

twitter
object

Twitter Details

email
string

E-mail address

full_name
string

Full Name

profile_picture
string
(url)

URL of the user’s profile picture

raw_data
object

Raw Response Data

uuid
string
(uuid)

User ID

meta
object

Response Metadata

request_id
string
(uuid)

Request Reference ID

status
integer
(int32)

HTTP Response Code

version
string
(semver)

API Version

Path Parameters

user_uuid
string
(uuid)

User ID

Response

204 No Content

Returns the Custom Data for a User

Path Parameters

user_uuid
string
(uuid)

User ID

Response

200
data
object

Resource Data

meta
object

Response Metadata

request_id
string
(uuid)

Request Reference ID

status
integer
(int32)

HTTP Response Code

version
string
(semver)

API Version

Sets a new custom data object for a User. The JSON body sent to this endpoint will become the new custom data object for the user.

Path Parameters

user_uuid
string
(uuid)

User ID

Response

200
data
object

Resource Data

meta
object

Response Metadata

request_id
string
(uuid)

Request Reference ID

status
integer
(int32)

HTTP Response Code

version
string
(semver)

API Version

Models

The following is a collection of model references

CustomUserDetails

schema application/json
external_id
string

Custom User ID

TwitterUserDetails

schema application/json
twitter_id
string

Twitter ID

GithubUserDetails

schema application/json
github_id
string

Github ID

MinimalUserDetails

schema application/json
app_id
string

App ID

uuid
string
(uuid)

User ID

UserDetails

schema application/json
image
string
(url)

URL of a User Profile image

name
string

Full Name

LinkedInUserDetails

schema application/json
linkedin_id
string

LinkedIn ID

TwitterSocialDetails

schema application/json
email
string

E-mail address

full_name
string

Full Name

profile_picture
string
(url)

URL of the user’s profile picture

raw_data
object

Raw Response Data

InstagramUserDetails

schema application/json
instagram_id
string

Instagram ID

InstagramSocialDetails

schema application/json
email
string

E-mail address

full_name
string

Full Name

profile_picture
string
(url)

URL of the user’s profile picture

raw_data
object

Raw Response Data

FacebookUserDetails

schema application/json
facebook_id
string

Facebook ID

User

schema application/json
app_id
string

App ID

created
string
(date-time)

Creation timestamp

custom
object

Custom Data

details
object

User Details. This object will additionally contain properties from one of the following details models: EmailPassword, Custom, Facebook, Github, Google, LinkedIn, Instagram, Twitter

image
string
(url)

URL of a User Profile image

name
string

Full Name

social
object

Social Details

facebook
object

Facebook Details

email
string

E-mail address

full_name
string

Full Name

profile_picture
string
(url)

URL of the user’s profile picture

raw_data
object

Raw Response Data

github
object

Github Details

email
string

E-mail address

full_name
string

Full Name

profile_picture
string
(url)

URL of the user’s profile picture

raw_data
object

Raw Response Data

google
object

Google Details

email
string

E-mail address

full_name
string

Full Name

profile_picture
string
(url)

URL of the user’s profile picture

raw_data
object

Raw Response Data

instagram
object

Instagram Details

email
string

E-mail address

full_name
string

Full Name

profile_picture
string
(url)

URL of the user’s profile picture

raw_data
object

Raw Response Data

linkedin
object

LinkedIn Details

email
string

E-mail address

full_name
string

Full Name

profile_picture
string
(url)

URL of the user’s profile picture

raw_data
object

Raw Response Data

twitter
object

Twitter Details

email
string

E-mail address

full_name
string

Full Name

profile_picture
string
(url)

URL of the user’s profile picture

raw_data
object

Raw Response Data

uuid
string
(uuid)

User ID

GithubSocialDetails

schema application/json
email
string

E-mail address

full_name
string

Full Name

profile_picture
string
(url)

URL of the user’s profile picture

raw_data
object

Raw Response Data

FacebookSocialDetails

schema application/json
email
string

E-mail address

full_name
string

Full Name

profile_picture
string
(url)

URL of the user’s profile picture

raw_data
object

Raw Response Data

GoogleUserDetails

schema application/json
google_id
string

Google+ ID

SocialDetails

schema application/json
facebook
object

Facebook Details

email
string

E-mail address

full_name
string

Full Name

profile_picture
string
(url)

URL of the user’s profile picture

raw_data
object

Raw Response Data

github
object

Github Details

email
string

E-mail address

full_name
string

Full Name

profile_picture
string
(url)

URL of the user’s profile picture

raw_data
object

Raw Response Data

google
object

Google Details

email
string

E-mail address

full_name
string

Full Name

profile_picture
string
(url)

URL of the user’s profile picture

raw_data
object

Raw Response Data

instagram
object

Instagram Details

email
string

E-mail address

full_name
string

Full Name

profile_picture
string
(url)

URL of the user’s profile picture

raw_data
object

Raw Response Data

linkedin
object

LinkedIn Details

email
string

E-mail address

full_name
string

Full Name

profile_picture
string
(url)

URL of the user’s profile picture

raw_data
object

Raw Response Data

twitter
object

Twitter Details

email
string

E-mail address

full_name
string

Full Name

profile_picture
string
(url)

URL of the user’s profile picture

raw_data
object

Raw Response Data

LinkedInSocialDetails

schema application/json
email
string

E-mail address

full_name
string

Full Name

profile_picture
string
(url)

URL of the user’s profile picture

raw_data
object

Raw Response Data

GoogleSocialDetails

schema application/json
email
string

E-mail address

full_name
string

Full Name

profile_picture
string
(url)

URL of the user’s profile picture

raw_data
object

Raw Response Data

EmailPasswordUserDetails

schema application/json
email
string
(email)

E-mail address

username
string

Display username

Services

    API

      General