[1.23.0] Users

 

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.

Structure

Resource User has attributes:

Attribute

Type

Description

Availability

Attribute

Type

Description

Availability

id

Integer

Unique user ID (InPost ID).

PL, IT

email

String

E-mail assigned to user account.

PL, IT

first_name

String

First name.

PL, IT

last_name

String

Last name.

PL, IT

status

String

User status.

PL, IT

updated_at

DateTime

Last update.

PL, IT

created_at

DateTime

Creation date.

PL, IT

Example  in JSON:

1 2 3 4 5 6 7 8 9 10 { "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/28639247

1 GET /v1/organizations/:organization_id/users

Search criteria

Parameter

Description

Availability

Parameter

Description

Availability

q

Allows to search user by given phrase.

PL, IT

Sorting

Parameter

Description

Availability

Parameter

Description

Availability

sort_by

Default: id
Available: id, email, phone, full_name, created_at 

PL, IT

sort_order

Default: asc
Available: asc, desc

PL, IT

Request example

1 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.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 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" }, {...} ] }