[1.6.0] Users
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
Structure
Resource User has attributes:
Attribute | Type | Description |
|---|---|---|
| Integer | Unique user ID (InPost ID). |
| String | E-mail assigned to user account. |
| String | First name. |
| String | Last name. |
| String | User status. |
| DateTime | Last update. |
| DateTime | 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"
}
User List
Access to resource::
owner of organization has access to full list of users,
normal user has the ability to see only himself.
GET /v1/organizations/:organization_id/usersSearch criteria
Parameter | Description |
|---|---|
| Allows to search user by given phrase. |
Sorting
Parameter | Description |
|---|---|
| Default: |
| Default: |
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.
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"
},
{...}
]
}