GET /users
Requires authentication with server access token.
List users. All query parameters are user properties that will be used to search for users. When sending multiple query parameters, the API performs an AND
search. Some parameters are used to fuzzy match, while others perform exact matches. See the parameter list for details on which does what.
All regular expression queries use Perl Compatible Regular Expression syntax, as implemented in PHP and other places.
Search examples
Get name, userId, email and gender from users where familyName starts with "Olsen" and gender is male, limit to 10 users:
curl http://identity-pre.schibsted.com/api/2/users?oauth_token=TOKEN& \
limit=10& \
offset=0& \
familyName=Olsen& \
gender=male& \
fields=name,userId,email,gender
Get the whole user object from users where email matches exactly "johndoe@example.com":
curl http://identity-pre.schibsted.com/api/2/users?oauth_token=TOKEN& \
email=johndoe@example.com
Get all users that where registered between 2011-01-20 (timestamp 1295478000) and 2011-01-21:
curl http://identity-pre.schibsted.com/api/2/users?oauth_token=TOKEN& \
since=1295478000& \
until=2011-01-21
Get all users that where registered between yesterday and now:
curl http://identity-pre.schibsted.com/api/2/users?oauth_token=TOKEN& \
since=yesterday& \
until=now
Filters
The endpoint supports many filters (see below). If no filters are provided, active users for the client is returned. Users with status 0 and 1 are considered active. If since and until parameter are provided but no updated filter, since and until will be used together with published
field instead of updated
field.
See also
Help us improve
Did you spot an error? Or maybe you just have a suggestion for how we can improve? Leave us a comment.
Request
GET /api/2/users
fields | optionalA list of fields to select, makes for a slimmer response. |
---|---|
sort | optional |
id | optionalExact match. |
userId | optionalExact match. |
optionalExact match for the primary email. | |
emails | optionalExact match for either the primary or one of the secondary emails. |
filters | optional
|
The pagination parameters limit, since, offset, and until are also supported.
Example request
curl
Minimal example
curl https://login.schibsted.com/api/2/users -G \
-H "Authorization: Bearer [access token]"
With all parameters
curl https://login.schibsted.com/api/2/users -G \
-H "Authorization: Bearer [access token]" \
-d "fields=id,fullName,email" \
-d "sort=userId" \
-d "id=1337" \
-d "userId=42" \
-d "email=johnd@example.com" \
-d "emails=johnd@example.com"
Response
This endpoint supports the JSON, JSON-P, and response formats.
Success: 200 OK
Returns all users matched by the query.
User
The user object is based on the portable contacts specification. It is extended with some custom fields. userId
is an integer and represents the unique user ID, while id
is a legacy uuid and should be ignored in new integrations. The uuid
is also a user identifier, which is is globally unique and should therefore be the preferred identifier for a user. The email
and phoneNumber
fields will always contain the primary used for both if available. The corresponding *Verified fields are the date of the last time those were verified.
When requesting a user that is not connected to the authorized client, only public profile data will be available:
id
userId
uuid
status
displayName
name
gender
preferredUsername
utcOffset
published
updated
lastLoggedIn
locale
tracking
id ✓ | stringLegacy |
---|---|
userId ✓ | integer (as string)Unique user ID. Custom extension. |
uuid ✓ | stringUnique user UUID. Custom extension. Should be preferred as the user identifier. |
name ✓ | NameJSON object containing |
displayName ✓ | stringName suitable for displaying to end-users. |
published ✓ | date-timeThe date this user was first added. Can return false if the user account was deleted. |
updated ✓ | date-timeThe most recent date the details of this user were updated |
status ✓ | User status |
email ✓ | stringPrimary email |
emailVerified | stringDate when the email was last verified. |
emails ✓ | list of Email addressesAll user's registered email addresses. |
phoneNumber | stringPrimary phone number |
phoneNumberVerified | stringDate when the phone number was last verified. |
phoneNumbers | list of Phone numbersAll user's registered phone numbers. |
verified | stringDate when user last verified data (email, phone number). Returns false if user wasn't verified. |
url | string |
photo | stringURL to a photo of the user (GIF/JPG/PNG) |
preferredUsername | string |
gender ✓ | stringOne of undisclosed, female, male, other, withheld. Default is undisclosed. Portable contacts |
birthday ✓ | dateDate of birth in YYYY-MM-DD format. Year will be 0000 if not provided. Defaults to 0000-00-00. Portable contacts |
locale ✓ | stringThe user's preferred locale. Locales follow ISO Language and country codes respectively, joined by an underscore. |
utcOffset ✓ | stringThe user's timezone, given as offset from UTC. |
lastLoggedIn ✓ | datetimeReturns false if the user has not been logged in before. |
lastAuthenticated ✓ | datetimeThe last time the user authenticated with their password. Returns false if the user has not been authenticated before. |
imported | datetime |
migrated | datetime |
addresses | collection of Addresses, as an object with |
accounts | list of Third-party accountsThird-party accounts and other client services |
merchants | arrayList of Schibsted account merchants the user is connected to |
currentLocation | list of AddressesIf user has no current location returns empty array. |
tracking | booleanIf |
The check mark ✓ indicates that the field always contains a valid non-empty value.
Failure cases
Some HTTP response codes are used for multiple error situations. There is no consistent way to tell these apart, but the error object will contain a textual explanation of the reason for the error. For explanation on OAuth related failures and errors see OAuth authentication failures.
- 400 Bad Request Invalid parameter value
- 401 Unauthorized You don't have administration rights for this client.
- 401 Unauthorized Your client doesn't have administration rights for this client.
- 403 Forbidden Client is not authorized to access this API endpoint. Contact Schibsted account to request access.
- 403 Forbidden Requesting IP is not whitelisted
- 403 Forbidden Access token rejected
- 404 Not Found Unknown client ID
- 404 Not Found Client ID mismatch. The client making the request is no the owner of this resource, and does not have administrative privileges for it.
- 404 Not Found No users found
- 420 Request Ratelimit exceeded
Sample response
JSON
[
{
"status": 1,
"gender": "female",
"userId": "658898",
"name": {
"familyName": "Bergsten",
"givenName": "Claes",
"formatted": "Claes Bergsten"
},
"locale": "nb_NO",
"displayName": "Claes",
"utcOffset": "+02:00",
"published": "2013-04-03 14:48:31",
"updated": "2014-04-11 15:37:07",
"preferredUsername": "Claes",
"id": "515c251fefd04bcd36000003",
"lastLoggedIn": "2014-04-22 13:29:20"
}
]
JSON-P
callback([
{
"status": 1,
"gender": "female",
"userId": "658898",
"name": {
"familyName": "Bergsten",
"givenName": "Claes",
"formatted": "Claes Bergsten"
},
"locale": "nb_NO",
"displayName": "Claes",
"utcOffset": "+02:00",
"published": "2013-04-03 14:48:31",
"updated": "2014-04-11 15:37:07",
"preferredUsername": "Claes",
"id": "515c251fefd04bcd36000003",
"lastLoggedIn": "2014-04-22 13:29:20"
}
]);
Comments/feedback
Do you have questions, or just want to contribute some newly gained insight? Want to share an example? Please leave a comment. Our team reads and responds to every question. Additionally, your experience can help others using Schibsted account, and it can help us continuously improve our documentation.