Goto Users API Documentation

Getting Started

Goto Users is a large user database for testing, validating, and more.

The users are available through the API which is a RESTful API that allows you to acces user data in different ways depending upon the endpoint you use.

The Goto Users API base url is: https://gotousers.herokuapp.com/api/v1

No authentication is currently required to access the API, but in the future it will be added to meter & collect usage data along with allowing for account specific features.

Example Request

https://gotousers.herokuapp.com/api/v1/users/getOneUser

This endpoint will return one random user, as a JSON object in the following format:

(A full list of user endpoints can be found here) 

{
  "_id": "627cc3181683b442bc0dc14e",
  "record": {
    "firstName": "Becky",
    "lastName": "Wilson",
    "age": 39,
    "email": "becky.wilson@example.com",
    "dob": "1983-05-02T16:12:23.983Z"
  },
  "id": "290-82-9697",
  "company": "Stamm, Durgan and Renner",
  "jobTitle": "Microbiologist",
  "registration": {
    "registrationDate": "2010-08-28T07:42:32.540Z"
  },
  "location": {
    "country": "United States",
    "state": "Hawaii",
    "city": "Jacksonville",
    "address": "3736 W Belt Line Rd"
  },
  "phone": "(178)-426-5749",
  "__v": 0
}

User Object

The user object contains the follow fields:

Property Type Description
_id String The unique identifier for the user
record Object The user's record
id String The user's ID
company String The user's company
jobTitle String The user's job title
registration Object The user's registration information
location Object The user's location information
phone String The user's phone number
__v Number The version of the user

User Records

The user record contains the following fields:

Property Type Description
firstName String The user's first name
lastName String The user's last name
age Number The user's age
email String The user's email address
dob Date/String The user's date of birth

User Registration

The user registration contains the following fields:

Property Type Description
registrationDate Date/String The date the user registered

User Location

The user location contains the following fields:

Property Type Description
country String The user's country
state String The user's state
city String The user's city
address String The user's address