Identity Management

GET /mail

Requires authentication with server access token.

List mail history and events for specified user.

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/mail

id

optional

The user's uuid or userId (not to be mistaken with the deprecated id)

email

optional

Email of the user. Must be unique across all of SPiD

Example request

cURL
Minimal example
curl https://login.schibsted.com/api/2/mail -G \
   -d "oauth_token=[access token]"
With all parameters
curl https://login.schibsted.com/api/2/mail -G \
   -d "oauth_token=[access token]" \
   -d "id=1337" \
   -d "email=johnd@example.com"
Java
Minimal example
SpidOAuthToken token = spidClient.getServerToken();
String responseJSON = spidClient.
    GET(token, "/mail").
    getResponseBody();
With all parameters
Map<String, String> params = new HashMap<>() {{
    put("id", "1337");,
    put("email", "johnd@example.com");
}};

SpidOAuthToken token = spidClient.getServerToken();
String responseJSON = spidClient.
    GET(token, "/mail", params).
    getResponseBody();

This example is an excerpt, see a full example

PHP
Minimal example
<?php
$client->auth();
echo var_dump($client->api("/mail"));
With all parameters
<?php
$params = array(
    "id" => "1337",
    "email" => "johnd@example.com"
);

$client->auth();
echo var_dump($client->api("/mail", $params));

This example is an excerpt, see a full example

Clojure
Minimal example
(ns example
  (:require [spid-client-clojure.core :as spid]))

(let [client (spid/create-client "[client-id]" "[secret]")
      token (spid/create-server-token client)]
  (spid/GET client token "/mail"))
With all parameters
(ns example
  (:require [spid-client-clojure.core :as spid]))

(let [client (spid/create-client "[client-id]" "[secret]")
      token (spid/create-server-token client)]
  (spid/GET client token "/mail" {"id" "1337"
                                  "email" "johnd@example.com"}))

Response

This endpoint supports the JSON and JSON-P response formats.

Success: 200 OK

Returns a list of mail objects

Mail

template

string

Used template name

senderName

string

Sender name

senderEmail

string

Sender e-mail address

userName

string

Recipient name

userEmail

string

Recipient e-mail address

created

timestamp, in seconds

Created at timestamp

token

string

E-mail token

events

list of Mail events

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 No valid parameter provided
  • 400 Bad Request Email parameter did not properly base64 decode into a valid email
  • 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 SPiD 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.
  • 420 Request Ratelimit exceeded

Sample response

JSON
[
    {
        "template": "confirm_account_notification",
        "senderName": "E-mail sender",
        "senderEmail": "noreply@schibsted.com",
        "userName": "John",
        "userEmail": "email@example.pl",
        "created": 1472036646,
        "token": "76c4f401-a2fe-45a5-bcce-e49656663e35",
        "events": [
            {
                "event": "sent",
                "timestamp": 1472036647
            }
        ]
    }
]
JSON-P
callback([
    {
        "template": "confirm_account_notification",
        "senderName": "E-mail sender",
        "senderEmail": "noreply@schibsted.com",
        "userName": "John",
        "userEmail": "email@example.pl",
        "created": 1472036646,
        "token": "76c4f401-a2fe-45a5-bcce-e49656663e35",
        "events": [
            {
                "event": "sent",
                "timestamp": 1472036647
            }
        ]
    }
]);

Comments/feedback

Do you have questions, or just want to contribute some newly gained insight? Want to share an example? Please leave a comment. SPiD reads and responds to every question. Additionally, your experience can help others using SPiD, and it can help us continuously improve our documentation.