List Users of User Group¶
This endpoint returns a paginated list of all the users included in a user group.
Request¶
GET https://v2.api.uberflip.com/user-groups/{groupId}/users
Path Parameters | Description |
---|---|
groupId | The unique identifier of the user group |
Response¶
The response will contain a users collection:
Body Parameters | Type | Description |
---|---|---|
data | Array | The collection of users |
meta | Object | See: Pagination |
Each user in the collection will have properties:
Body Parameters | Type | Description |
---|---|---|
id | Integer | The unique user identifier |
first_name | String | The user first name |
last_name | String | The user last name |
String | The user email address | |
federation_id | String | The user federation Id (SSO) |
avatar_url | String | The user avatar image URL |
calendly_url | String | The user Calendly URL |
google_plus_id | String | The user Google Plus Id |
twitter_handle | String | The user Twitter handle |
linkedin_profile_url | String | The user LinkedIn URL |
website_url | String | The user website URL |
bio | String | The user bio text |
author_url | String | The user author page URL |
last_logged_in_at | String | The user last login date |
last_logged_in_from | String | The user last logged IP address |
created_at | DateTime | The user creation time |
modified_at | DateTime | The user last updated time |
Examples¶
curl -H "Authorization: Bearer [Token]" \
-i https://v2.api.uberflip.com/user-groups/{groupId}/users
Sample response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": 1,
"first_name": "User",
"last_name": "One",
"email": "userone@user.com",
"federation_id": null,
"avatar_url": "https://content.cdntwrk.com/files/YV91PTE2NjEzNSZtb2RpZmllZD0yMDF4LTExLTIwIDE0OjU0OjE0JnNpZz0wYjgzMzllZmE1MTJmOTBkM2UxMjVlMjY5MGFjM2U1Nw%253D%253D",
"calendly_url": null,
"google_plus_id": null,
"twitter_handle": "userone",
"linkedin_profile_url": null,
"website_url": null,
"bio": "user biography",
"author_url_slug": "user-one",
"last_logged_in_at": "2018-11-20T14:54:14-0500",
"last_logged_in_from": "38.117.100.180",
"created_at": "2012-06-06T15:39:18-0400",
"modified_at": "2018-11-20T14:54:14-0500"
},
{
"id": 2,
"first_name": "User",
"last_name": "Two",
"email": "usertwo@user.com",
"federation_id": null,
"avatar_url": "https://content.cdntwrk.com/files/YV91PTE2NjEzNRZtb2RpZmllZD0yMDF4LTExLTIwIDE0OjU0OjE0JnNpZz0wYjgzMzllZmE1MTJmOTBkM4UxMjVlMjY5MGFjM2U1Nw%253D%253D",
"calendly_url": null,
"google_plus_id": null,
"twitter_handle": "usertwo",
"linkedin_profile_url": null,
"website_url": null,
"bio": "user biography",
"author_url_slug": "user-two",
"last_logged_in_at": "2018-11-20T14:54:14-0500",
"last_logged_in_from": "38.117.100.180",
"created_at": "2012-06-06T15:39:18-0400",
"modified_at": "2018-11-20T14:54:14-0500"
},
{
"id": 3,
"first_name": "User",
"last_name": "Three",
"email": "userthree@user.com",
"federation_id": null,
"avatar_url": "https://content.cdntwrk.com/files/YV91PTE2NjEz9SZtb2RpZmllZD0yM3F4LTExLTIwIDE0OjU0OjE0XnNpZz0wYjgzMzllZmE1MTJmOTBkM2UxMjVlMjY5MAFjM2U1Nw%253D%253D",
"calendly_url": null,
"google_plus_id": null,
"twitter_handle": "userthree",
"linkedin_profile_url": null,
"website_url": null,
"bio": "user biography",
"author_url_slug": "user-three",
"last_logged_in_at": "2018-11-20T14:54:14-0500",
"last_logged_in_from": "38.117.100.180",
"created_at": "2012-06-06T15:39:18-0400",
"modified_at": "2018-11-20T14:54:14-0500"
},
],
"meta": {
"count": 3,
"limit": 25,
"total_pages": 1
}
}