People
Summary of people endpoints
- GET /admin/api/people - list all available people for the current site.
- GET /admin/api/people/1 - get data for a single person.
List all available people for the current site
GET /admin/api/people
Example response:
Status: 200 OK
[
{
"id": 1,
"firstname": "John",
"lastname": "Smith",
"name": "John Smith",
"phone": null,
"email": "tanel@example.com",
"working_language": "en",
"status": "ACTIVATED",
"owner": true,
"created_at": "2014-01-23T09:19:04.000Z",
"updated_at": "2014-01-24T10:03:02.000Z",
"last_login_at": "2014-01-24T12:11:02.000Z",
"url": "http://helloworld.voog.co/admin/api/people/1"
}, {
"id": 2,
"firstname": null,
"lastname": null,
"name": "api@example.com",
"phone": null,
"email": "api@example.com",
"working_language": "en",
"status": "ACTIVATED",
"owner": true,
"created_at": "2014-01-23T10:03:04.000Z",
"updated_at": "2014-01-24T13:01:22.000Z",
"last_login_at": "2014-01-24T13:01:22.000Z",
"url": "http://helloworld.voog.co/admin/api/people/2"
}
]
Parameters
per_page
- elements per response (default:50
; maximum:250
).page
- requested page (default:1
).
Filter attributes
Read more about filters.
- Object
person
attributes:id
,email
,firstname
,lastname
,working_language
,status
,owner
,created_at
,updated_at
,last_login_at
.
Get data for a single person
GET /admin/api/people/1
Example request:
GET http://helloworld.voog.co/admin/api/people/1
Example response:
Status: 200 OK
{
"id": 1,
"firstname": "John",
"lastname": "Smith",
"name": "John Smith",
"phone": null,
"email": "tanel@example.com",
"working_language": "en",
"status": "ACTIVATED",
"owner": true,
"created_at": "2014-01-23T09:19:04.000Z",
"updated_at": "2014-01-24T10:03:02.000Z",
"last_login_at": "2014-01-24T12:11:02.000Z",
"url": "http://helloworld.voog.co/admin/api/people/1"
}