[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

1 Structure
2 Authorization
3 User List

Structure

Resource User has attributes:

Attribute	Type	Description

Attribute	Type	Description
`id`	Integer	Unique user ID (InPost ID).
`email`	String	E-mail assigned to user account.
`first_name`	String	First name.
`last_name`	String	Last name.
`status`	String	User status.
`updated_at`	DateTime	Last update.
`created_at`	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"
}

Authorization

Access to a resource requires a correct and valid access token.

User List

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 https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/18153477

GET /v1/organizations/:organization_id/users

Search criteria

Parameter	Description

Parameter	Description
`q`	Allows to search user by given phrase.

Sorting

Parameter	Description

Parameter	Description
`sort_by`	Default: `id` Available: `id`, `email`, `phone`, `full_name`, `created_at`
`sort_order`	Default: `asc` Available: `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.

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" 
		},
		{...}
	]
}