Users API to retrieve users

Supported Formats: json

GET /v1/users/:user_id/users Load all users

GET /v1/users Load all users

Params

Param nameDescription
page
optional

the current page number when paginating this resource


Value:

Must be integer.


Metadata: 
parameter type: query parameter
limit
optional

the number of items per page when paginating this resource


Value:

Must be integer.


Metadata: 
parameter type: query parameter

Supported Formats

json

Examples

Request

GET /v1/users?auth_token=RzZ1Nv_2jsdpr4pCuXzo&limit=3&page=2

Response

200
[
  {
    "id": 169,
    "created_at": "2016-06-10T12:17:10.460+02:00",
    "screen_name": "Jeffrey 169",
    "real_name": "Mark Edwards",
    "avatar_file": {
      "url": "/spec_uploads/user/avatar_file/169/example.jpg",
      "medium": {
        "url": "/spec_uploads/user/avatar_file/169/medium_example.jpg"
      },
      "span4": {
        "url": "/spec_uploads/user/avatar_file/169/span4_example.jpg"
      },
      "span2": {
        "url": "/spec_uploads/user/avatar_file/169/span2_example.jpg"
      },
      "span1": {
        "url": "/spec_uploads/user/avatar_file/169/span1_example.jpg"
      },
      "mini": {
        "url": "/spec_uploads/user/avatar_file/169/mini_example.jpg"
      }
    },
    "url": "http://realcube.net",
    "location": "France",
    "skills": []
  },
  {
    "id": 170,
    "created_at": "2016-06-10T12:17:10.493+02:00",
    "screen_name": "Mark 170",
    "real_name": "Richard Castillo",
    "avatar_file": {
      "url": "/spec_uploads/user/avatar_file/170/example.jpg",
      "medium": {
        "url": "/spec_uploads/user/avatar_file/170/medium_example.jpg"
      },
      "span4": {
        "url": "/spec_uploads/user/avatar_file/170/span4_example.jpg"
      },
      "span2": {
        "url": "/spec_uploads/user/avatar_file/170/span2_example.jpg"
      },
      "span1": {
        "url": "/spec_uploads/user/avatar_file/170/span1_example.jpg"
      },
      "mini": {
        "url": "/spec_uploads/user/avatar_file/170/mini_example.jpg"
      }
    },
    "url": "http://realmix.gov",
    "location": "Guinea",
    "skills": []
  },
  {
    "id": 167,
    "created_at": "2016-06-10T12:17:10.383+02:00",
    "screen_name": "Nicole 167",
    "real_name": "Nicole Kim",
    "avatar_file": {
      "url": "/spec_uploads/user/avatar_file/167/example.jpg",
      "medium": {
        "url": "/spec_uploads/user/avatar_file/167/medium_example.jpg"
      },
      "span4": {
        "url": "/spec_uploads/user/avatar_file/167/span4_example.jpg"
      },
      "span2": {
        "url": "/spec_uploads/user/avatar_file/167/span2_example.jpg"
      },
      "span1": {
        "url": "/spec_uploads/user/avatar_file/167/span1_example.jpg"
      },
      "mini": {
        "url": "/spec_uploads/user/avatar_file/167/mini_example.jpg"
      }
    },
    "url": "http://twitterlist.edu",
    "location": "South Africa",
    "skills": []
  }
]

PUT /api/users/whoami

Supported Formats

json

Examples

Request

GET /v1/user/whoami?auth_token=xUixYVWxiP_e5brwsWZ-

Response

200
{
  "id": 181,
  "email": "rkim@skimia.org",
  "authentication_token": null,
  "created_at": "2016-06-10T12:17:11.877+02:00",
  "updated_at": "2016-06-10T12:17:11.877+02:00",
  "slug": "adam-181",
  "name": "Samuel Campbell",
  "screen_name": "Adam 181",
  "about": "<p>Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Proin risus. Praesent lectus.</p>",
  "send_comment_on_design_notifications": true,
  "real_name": "Kevin Ward",
  "avatar_file": {
    "url": "/spec_uploads/user/avatar_file/181/example.jpg",
    "medium": {
      "url": "/spec_uploads/user/avatar_file/181/medium_example.jpg"
    },
    "span4": {
      "url": "/spec_uploads/user/avatar_file/181/span4_example.jpg"
    },
    "span2": {
      "url": "/spec_uploads/user/avatar_file/181/span2_example.jpg"
    },
    "span1": {
      "url": "/spec_uploads/user/avatar_file/181/span1_example.jpg"
    },
    "mini": {
      "url": "/spec_uploads/user/avatar_file/181/mini_example.jpg"
    }
  },
  "url": "http://kwilith.name",
  "location": "Haiti",
  "show_random": false,
  "follow_conversations": true,
  "last_used_device_id": null,
  "group_id": null,
  "skills": [],
  "banned": null,
  "send_follow_notifications": true,
  "send_your_design_got_printed_notifications": true,
  "send_your_design_got_added_to_collection_notifications": true,
  "send_new_design_by_person_you_follow_notifications": true,
  "wants_newsletter": true,
  "email_token": "5d96cb9f04801f1399b2faaa",
  "donate_url": null,
  "send_collection_updated_follower_notifications": true,
  "role": "user"
}

GET /v1/users/:user_id/users/:id Load a specific user by ID or slug

GET /v1/users/:id Load a specific user by ID or slug

Supported Formats

json

Examples

Request

GET /v1/users/betty-178

Response

200
{
  "id": 178,
  "created_at": "2016-06-10T12:17:10.944+02:00",
  "screen_name": "Betty 178",
  "real_name": "Ryan Graham",
  "avatar_file": {
    "url": "/spec_uploads/user/avatar_file/178/example.jpg",
    "medium": {
      "url": "/spec_uploads/user/avatar_file/178/medium_example.jpg"
    },
    "span4": {
      "url": "/spec_uploads/user/avatar_file/178/span4_example.jpg"
    },
    "span2": {
      "url": "/spec_uploads/user/avatar_file/178/span2_example.jpg"
    },
    "span1": {
      "url": "/spec_uploads/user/avatar_file/178/span1_example.jpg"
    },
    "mini": {
      "url": "/spec_uploads/user/avatar_file/178/mini_example.jpg"
    }
  },
  "url": "http://wikido.biz",
  "location": "Saudia Arabia",
  "skills": []
}

GET /v1/users/:id/designs Load all the designs of an user

GET /v1/users/:user_id/users/:id/designs Load all the designs of an user

Supported Formats

json

Examples

Request

GET /v1/users/virginia-179/designs?auth_token=jTC85LkpApPf2eske8cw

Response

200
[
  {
    "id": 136,
    "name": "Topicshots 137",
    "slug": "topicshots-137",
    "description": "<p>Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Proin risus. Praesent lectus.</p>",
    "user_id": 179,
    "created_at": "2016-06-10T12:17:11.569+02:00",
    "updated_at": "2016-06-10T12:17:11.603+02:00",
    "primary_image_id": 22,
    "license": "ccbysa",
    "state": "published",
    "design_category_id": 137,
    "excerpt": "Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Proin risus. Praesent lectus.",
    "last_trending_popularity": 0.0,
    "current_delta_popularity": 0.0,
    "materials": "Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Proin risus. Praesent lectus.",
    "documents_zip": {
      "url": null
    },
    "download_count": 0,
    "documents_download_count": 0,
    "wiki_mode": false,
    "zipper_worker_uuid": null
  },
  {
    "id": 135,
    "name": "Wordpedia 136",
    "slug": "wordpedia-136",
    "description": "<p>Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Proin risus. Praesent lectus.</p>\n\n<p>Vestibulum quam sapien, varius ut, blandit non, interdum in, ante. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Duis faucibus accumsan odio. Curabitur convallis.</p>",
    "user_id": 179,
    "created_at": "2016-06-10T12:17:11.503+02:00",
    "updated_at": "2016-06-10T12:17:11.538+02:00",
    "primary_image_id": 21,
    "license": "ccbysa",
    "state": "published",
    "design_category_id": 136,
    "excerpt": "Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Proin risus. Praesent lectus.",
    "last_trending_popularity": 0.0,
    "current_delta_popularity": 0.0,
    "materials": "Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Proin risus. Praesent lectus.\n\nVestibulum quam sapien, varius ut, blandit non, interdum in, ante. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Duis faucibus accumsan odio. Curabitur convallis.",
    "documents_zip": {
      "url": null
    },
    "download_count": 0,
    "documents_download_count": 0,
    "wiki_mode": false,
    "zipper_worker_uuid": null
  },
  {
    "id": 134,
    "name": "Browsecat 135",
    "slug": "browsecat-135",
    "description": "<p>Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Proin risus. Praesent lectus.</p>\n\n<p>Vestibulum quam sapien, varius ut, blandit non, interdum in, ante. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Duis faucibus accumsan odio. Curabitur convallis.</p>",
    "user_id": 179,
    "created_at": "2016-06-10T12:17:11.436+02:00",
    "updated_at": "2016-06-10T12:17:11.473+02:00",
    "primary_image_id": 20,
    "license": "gplv3",
    "state": "published",
    "design_category_id": 135,
    "excerpt": "Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Proin risus. Praesent lectus.",
    "last_trending_popularity": 0.0,
    "current_delta_popularity": 0.0,
    "materials": "",
    "documents_zip": {
      "url": null
    },
    "download_count": 0,
    "documents_download_count": 0,
    "wiki_mode": false,
    "zipper_worker_uuid": null
  },
  {
    "id": 133,
    "name": "Skipstorm 134",
    "slug": "skipstorm-134",
    "description": "<p>Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Proin risus. Praesent lectus.</p>\n\n<p>Vestibulum quam sapien, varius ut, blandit non, interdum in, ante. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Duis faucibus accumsan odio. Curabitur convallis.</p>",
    "user_id": 179,
    "created_at": "2016-06-10T12:17:11.370+02:00",
    "updated_at": "2016-06-10T12:17:11.406+02:00",
    "primary_image_id": 19,
    "license": "ccbysa",
    "state": "published",
    "design_category_id": 134,
    "excerpt": "Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Proin risus. Praesent lectus.",
    "last_trending_popularity": 0.0,
    "current_delta_popularity": 0.0,
    "materials": "Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Proin risus. Praesent lectus.\n\nVestibulum quam sapien, varius ut, blandit non, interdum in, ante. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Duis faucibus accumsan odio. Curabitur convallis.",
    "documents_zip": {
      "url": null
    },
    "download_count": 0,
    "documents_download_count": 0,
    "wiki_mode": false,
    "zipper_worker_uuid": null
  },
  {
    "id": 132,
    "name": "Wikido 133",
    "slug": "wikido-133",
    "description": "<p>Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Proin risus. Praesent lectus.</p>\n\n<p>Vestibulum quam sapien, varius ut, blandit non, interdum in, ante. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Duis faucibus accumsan odio. Curabitur convallis.</p>",
    "user_id": 179,
    "created_at": "2016-06-10T12:17:11.305+02:00",
    "updated_at": "2016-06-10T12:17:11.339+02:00",
    "primary_image_id": 18,
    "license": "ccbysa",
    "state": "published",
    "design_category_id": 133,
    "excerpt": "Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Proin risus. Praesent lectus.",
    "last_trending_popularity": 0.0,
    "current_delta_popularity": 0.0,
    "materials": "Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Proin risus. Praesent lectus.\n\nVestibulum quam sapien, varius ut, blandit non, interdum in, ante. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Duis faucibus accumsan odio. Curabitur convallis.",
    "documents_zip": {
      "url": null
    },
    "download_count": 0,
    "documents_download_count": 0,
    "wiki_mode": false,
    "zipper_worker_uuid": null
  },
  {
    "id": 131,
    "name": "Avamm 132",
    "slug": "avamm-132",
    "description": "<p>Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Proin risus. Praesent lectus.</p>\n\n<p>Vestibulum quam sapien, varius ut, blandit non, interdum in, ante. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Duis faucibus accumsan odio. Curabitur convallis.</p>\n\n<p>Duis consequat dui nec nisi volutpat eleifend. Donec ut dolor. Morbi vel lectus in quam fringilla rhoncus.</p>",
    "user_id": 179,
    "created_at": "2016-06-10T12:17:11.242+02:00",
    "updated_at": "2016-06-10T12:17:11.276+02:00",
    "primary_image_id": 17,
    "license": "gplv3",
    "state": "published",
    "design_category_id": 132,
    "excerpt": "Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Proin risus. Praesent lectus.",
    "last_trending_popularity": 0.0,
    "current_delta_popularity": 0.0,
    "materials": "",
    "documents_zip": {
      "url": null
    },
    "download_count": 0,
    "documents_download_count": 0,
    "wiki_mode": false,
    "zipper_worker_uuid": null
  },
  {
    "id": 130,
    "name": "Skinix 131",
    "slug": "skinix-131",
    "description": "<p>Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Proin risus. Praesent lectus.</p>\n\n<p>Vestibulum quam sapien, varius ut, blandit non, interdum in, ante. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Duis faucibus accumsan odio. Curabitur convallis.</p>\n\n<p>Duis consequat dui nec nisi volutpat eleifend. Donec ut dolor. Morbi vel lectus in quam fringilla rhoncus.</p>\n\n<p>Mauris enim leo, rhoncus sed, vestibulum sit amet, cursus id, turpis. Integer aliquet, massa id lobortis convallis, tortor risus dapibus augue, vel accumsan tellus nisi eu orci. Mauris lacinia sapien quis libero.</p>",
    "user_id": 179,
    "created_at": "2016-06-10T12:17:11.169+02:00",
    "updated_at": "2016-06-10T12:17:11.211+02:00",
    "primary_image_id": 16,
    "license": "gplv3",
    "state": "published",
    "design_category_id": 131,
    "excerpt": "Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Proin risus. Praesent lectus.",
    "last_trending_popularity": 0.0,
    "current_delta_popularity": 0.0,
    "materials": "Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Proin risus. Praesent lectus.\n\nVestibulum quam sapien, varius ut, blandit non, interdum in, ante. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Duis faucibus accumsan odio. Curabitur convallis.",
    "documents_zip": {
      "url": null
    },
    "download_count": 0,
    "documents_download_count": 0,
    "wiki_mode": false,
    "zipper_worker_uuid": null
  },
  {
    "id": 129,
    "name": "Ntag 130",
    "slug": "ntag-130",
    "description": "<p>Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Proin risus. Praesent lectus.</p>\n\n<p>Vestibulum quam sapien, varius ut, blandit non, interdum in, ante. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Duis faucibus accumsan odio. Curabitur convallis.</p>\n\n<p>Duis consequat dui nec nisi volutpat eleifend. Donec ut dolor. Morbi vel lectus in quam fringilla rhoncus.</p>",
    "user_id": 179,
    "created_at": "2016-06-10T12:17:11.081+02:00",
    "updated_at": "2016-06-10T12:17:11.131+02:00",
    "primary_image_id": 15,
    "license": "gplv3",
    "state": "published",
    "design_category_id": 130,
    "excerpt": "Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Proin risus. Praesent lectus.",
    "last_trending_popularity": 0.0,
    "current_delta_popularity": 0.0,
    "materials": "",
    "documents_zip": {
      "url": null
    },
    "download_count": 0,
    "documents_download_count": 0,
    "wiki_mode": false,
    "zipper_worker_uuid": null
  }
]