GET /api/v1/users
Get a list of all users with pagination.

Get a list of all users with pagination.

Examples

GET /users.json

{  
"pages":13704,
"users":[
  {  
    "user":{  
      "username":"titan123x",
      "pf_name":null,
      "created":"2010-01-05T03:39:23.000-05:00",
      "pf_website":null,
      "user_profile":{  
        "about":null,
        "":null
      }
    }
  },
  {  
    "user":{  
      "username":"Jane",
      "pf_name":null,
      "created":"2010-01-05T04:22:29.000-05:00",
      "pf_website":null,
      "user_profile":{  
        "about":null,
        "":null
      }
    }
  },
  {  
    "user":{  
      "username":"seraqueda",
      "pf_name":null,
      "created":"2010-01-05T04:47:15.000-05:00",
      "pf_website":null,
      "user_profile":{  
        "about":null,
        "":null
      }
    }
  },
  {  
    "user":{  
      "username":"7music",
      "pf_name":null,
      "created":"2010-01-05T04:49:15.000-05:00",
      "pf_website":null,
      "user_profile":{  
        "about":null,
        "":null
      }
    }
  },
  {  
    "user":{  
      "username":"min03",
      "pf_name":null,
      "created":"2010-01-05T17:08:25.000-05:00",
      "pf_website":null,
      "user_profile":{  
        "about":null,
        "":null
      }
    }
  }
]
}

Supported Formats

json

Params

Param name Description
page
optional

The page to retrieve. Defaults to 1


Value: Must be a Integer

GET /api/v1/me
Retrieves user object for currently logged in user.

Retrieves user object for currently logged in user.

id

The ID of the user.

access_id

The user's subscription level. GET /access_levels to look up resource limits for this user.

uniquekey

The user's key for uploading new files.

bytes_total

The number of total bytes the user is currently storing.

upload_server

Returns the host that this user should upload to. Do not cache this value longer than 24 hours.

username

The user's unique username.

pf_name

The user's display name. If empty, use the user's username.

Examples

GET /me.json

{  
 "id":1,
 "access_id": 2,
 "uniquekey":"156b438...",
 "bytes_total":1317720000.0,
 "upload_server":"k002.kiwi6.com",
 "username":"quentin",
 "pf_name":"",
 "created":"2013-01-02T23:15:39Z",
 "pf_website":"",
 "user_profile":{  
    "about":"test",
    "location":{  
       "id":15,
       "name":"Indonesia"
    }
 }
 "artists":[
    artist: {
    "username":"Quentin",
  ...
  },
  ...
 ]
}

Supported Formats

json

GET /api/v1/users/:username
Retrieves user object.

Retrieves user object.

Examples

GET /users/quentin.json

{  
 "username":"quentin",
 "pf_name":"",
 "created":"2013-01-02T23:15:39Z",
 "pf_website":"",
 "user_profile":{  
    "about":"test",
    "location":{  
       "id":15,
       "name":"Indonesia"
    }
 }
}

Supported Formats

json

Params

Param name Description
username
required

The username of the user to retrieve.


Value: Must be a String