Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Info |
---|
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
Table of Contents |
---|
minLevel | 2 |
---|
Structure
Resource User
has attributes:
Attribute | Type | Description | Availability |
---|---|---|---|
| Integer | Unique user ID (InPost ID). | PL, IT |
| String | E-mail assigned to user account. | PL, IT |
| String | First name. | PL, IT |
| String | Last name. | PL, IT |
| String | User status. | PL, IT |
| DateTime | Last update. | PL, IT |
| DateTime | Creation date. | PL, IT |
Example in JSON:
Code Block | ||
---|---|---|
| ||
{
"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.
Info |
---|
|
The resource is paged |
. For more information |
Code Block | ||
---|---|---|
| ||
GET /v1/organizations/:organization_id/users |
Search criteria
Parameter | Description | Availability |
---|---|---|
| Allows to search user by given phrase. | PL, IT |
Sorting
Parameter | Description | Availability |
---|---|---|
| Default: | PL, IT |
| Default: | PL, IT |
Request example
Code Block | ||
---|---|---|
| ||
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.
Code Block | ||
---|---|---|
| ||
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"
},
{...}
]
} |