GET /user¶
GET /user v4 | GET /user v3 | GET /user v2
Warning
GET /user v2 is now officially deprecated and scheduled for removal on May, 1st 2023. Please move to use GET /user v4.
GET /user v3 is now officially deprecated and scheduled for removal on May, 1st 2023. Please move to use GET /user v4.
This URL returns information of the current user. The id
field contains
a unique user identifier. The options.feed
field is true
if the user
is an XML feed customer. The options.vanityUrl
field is true
if the
value of the links.displayUrl field in the advertisement is shown
in the search results. The hasAds
field is false
if the user has no ads at all (not even deleted).
The locations
field contains the user (or webshop) locations.
The isAPIManaged
field is true
when there is (at least one) API partner
using api-rw
scope for this customer. API partners using api-ro
only will not
count towards this value being true
.
GET /user v4¶
Scope |
|
Accept |
|
Example¶
GET /user
Accept: application/sellside.user-v4+json, application/json
200 OK HTTP/1.1
Content-Type: application/sellside.user-v4+json; charset=UTF-8
{
"id": 123,
"emailAddress": "someuser@somewhere.org",
"sellerName": "Some User",
"phoneNumber": "0612345678",
"options": {
"feed": true,
"vanityUrl": false
},
"locations": [
{
"houseNumber": "123",
"streetName": "Some street",
"city": "Some city",
"country": "Some country",
"postalCode": "1432AB",
"phoneNumber": "0612345678"
}
],
"hasAds": true,
"isAPIManaged": true
}
GET /user v3¶
Warning
This call is scheduled to be deprecated. Please use GET /user v4 instead.
Scope |
|
Accept |
|
Example¶
GET /user
Accept: application/sellside.user-v3+json, application/json
200 OK HTTP/1.1
Content-Type: application/sellside.user-v3+json; charset=UTF-8
{
"id": 123,
"emailAddress": "someuser@somewhere.org",
"sellerName": "Some User",
"phoneNumber": "0612345678",
"options": {
"feed": true,
"vanityUrl": false
},
"locations": [
{
"houseNumber": "123",
"streetName": "Some street",
"city": "Some city",
"country": "Some country",
"postalCode": "1432AB",
"phoneNumber": "0612345678"
}
],
"hasAds": true
}
GET /user v2¶
Warning
This call is scheduled to be deprecated. Please use GET /user v4 instead.
Scope |
|
Accept |
|
Example¶
GET /user
Accept: application/sellside.user-v2+json, application/json
200 OK HTTP/1.1
Content-Type: application/sellside.user-v2+json; charset=UTF-8
{
"id": 123,
"emailAddress": "someuser@somewhere.org",
"sellerName": "Some User",
"phoneNumber": "0612345678",
"options": {
"feed": true,
"vanityUrl": false
},
"locations": [
{
"houseNumber": "123",
"streetName": "Some street",
"city": "Some city",
"country": "Some country",
"postalCode": "1432AB",
"phoneNumber": "0612345678"
}
]
}