Versions Compared

Old Version 1

changes.mady.by.user Former user

Saved on

compared with

New Version Current

changes.mady.by.user Michał Machowski

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The Resource User resource represents the object of the user who gains a user object, which has access to the Ship X platform data.The user

User is identified by a unique number , known as - InPost ID. This number ID is unchangedimmutable.

PanelbgColor

#f0f0f0titleBGColor#f0f0f0title

On this page

Table of Contents
minLevel2
 

Authentication

Access to the resource requires provision of the correct and valid access token for the Organization

Zasób User 

Structure

Resource User has attributes:

Attribute

Type

Description

hrefString

Absolute URL to the resource.

id

Integer

Unique user ID (InPost ID).

email

String

E-mail

address

assigned to

the

user

's

account.

first_name

String

User's first

First name.

last_name

String

User's surname

Last name.

status

String

User

's

status.

updated_at

DateTime

Last update

of the user's profile

.

created_at

DateTime

Date created of the user's profile.

Sample User resource in the JSON format

Creation date.

Example  in JSON:

Code Block
languagejson
{
	"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

of the Organization's users

Collecting the list of the Organization's users:

code

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 see [1.3.0] API General Information

Code Block
languagejson
GET /v1/organizations/:organization_id

_organizacji
/users

(info) The resource is paged. More information on page  AXA Informacje ogólne.

Access to the resource:

    • the owner of the organization have access to the full list of users,
    • a regular user of the organization sees only themselves on the list.
ParametersBy default
Search criteria
Parameter
Description
q
Allows to search user by given phrase.
Sorting
Parameter
Description
sort_by
Determines the attribute by which the results are to be sorted.
Default: id
PossiblePossible
Available: id, email, phone, full_name, created_at 
sort_order
Determines the sorting type - descending (desc) or ascending (asc).
By default: ascending (asc)
 
Sample request
 Code Block$ curl
Default: asc
Available: asc, desc
q
Allows for searching for users with a preset phrase.
Request example
 Code Block
languagejson
curl -X GET https://
axa.
api-shipx
.
-pl.easypack24.net/v1/users 
\
	
-H 'Authorization: Bearer
 lkfjasd9f70y43ohriw...[ommited for brevity]...'
Response 
In reply to the sent request 
 token' -H 'Content-Type: application/json'
Response
In response to the submitted request, the server will return a collection with 
 the 
a list of 
 the User 
 user resource objects.
 Code Block
Example:
language
code
json
HTTP/1.1 200 OK
Content-Type: application/json

 

{
	"href": "https://
axa.
api-shipx
.
-pl.easypack24.net/v1/users",
	"count": 123,
	"page": 1,
	"per_page": 30,
	"items": [
		 { 
			"href": "https://
axa.
api-shipx
.
-pl.easypack24.net/v1/users/1", 
			"id": 1, "email": "example@email.com", 
			
... other User's attributes omitted for brevity ...
		},
		{
"first_name": "Bogus", 
			"last_name": "Name", 
			"status": "active", 
			"
href
updated_at": "
https://axa.shipx.pl.easypack24.net/v1/users/2
2015-09-29T15:22:00.000+02:00", 
			"
id
created_at": 
2,
			... other User's attributes omitted for brevity ...
		}
		... other collection's items omitted for brevity ...
"2015-09-29T15:22:00.000+02:00" 
		},
		{...}
	]
}