You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 4
Warning!
Resource is available only in: PL, IT
Resource User represents a user object, which has access to Ship X platform data.
User is identified by a unique number - InPost ID. This ID is immutable.
On this page
Resource User has attributes:
User
Attribute
Type
Description
Availability
id
Integer
Unique user ID (InPost ID).
PL, IT
email
String
E-mail assigned to user account.
first_name
First name.
last_name
Last name.
status
User status.
updated_at
DateTime
Last update.
created_at
Creation date.
Example in JSON:
{ "href": "https://api-shipx-pl.easypack24.net/v1/users/1", "id": 1, "email": "example@email.com", "first_name": "Bogus", "last_name": "Name", "status": "active", "updated_at": "2015-09-29T15:22:00.000+02:00", "created_at": "2015-09-29T15:22:00.000+02:00" }
Access to a resource requires a correct and valid access token.
Access to resource::
owner of organization has access to full list of users,
normal user has the ability to see only himself.
The resource is paged. For more information see [1.23.0] API General Information
GET /v1/organizations/:organization_id/users
Search criteria
Parameter
q
Allows to search user by given phrase.
Sorting
sort_by
Default: idAvailable: id, email, phone, full_name, created_at
phone
full_name
sort_order
Default: ascAvailable: asc, desc
asc
desc
Request example
curl -X GET https://api-shipx-pl.easypack24.net/v1/users -H 'Authorization: Bearer token' -H 'Content-Type: application/json'
Response
In response to the submitted request, the server will return a collection with a list of user resource objects.
user
HTTP/1.1 200 OK Content-Type: application/json { "href": "https://api-shipx-pl.easypack24.net/v1/users", "count": 123, "page": 1, "per_page": 30, "items": [ { "href": "https://api-shipx-pl.easypack24.net/v1/users/1", "id": 1, "email": "example@email.com", "first_name": "Bogus", "last_name": "Name", "status": "active", "updated_at": "2015-09-29T15:22:00.000+02:00", "created_at": "2015-09-29T15:22:00.000+02:00" }, {...} ] }