/retrieve

Use the /retrieve endpoint to retrieve a subscriber information.

Example URI
https://maitreapp.co/api/v1/list/retrieve?uuid=XXX&api_token=YYY&email=john.doe@email.com


URI Parameters

uuid string
(required) Your widget UUID.

api_token string
(required) Your api_token.

email string
(required) Your subscriber's email.


Response

200  success

{
  status: "ok",
  data: {
    response: "subscriber_retrieved",
    name: "John",
    email: "john.doe@email.com",
    code: "MFXXXX",
    position: 3543,
    referred: true, //true if the user has been referred
    referred_by: {
      name: "Mark Smith",
      email: "mark.smith@email.com",
      code: "MFYYYYY"
    }, // Return null if subscriber has not been referred
    people_referred: 4, //Number of people referred
    host: "http://mywebsite.com", //Url used to create referral link
    total_subscribers: 7364, //Total number of people in the list
  },
  calls_left: 482, //Api calls left for this hour
  timestamp: 1469109759 //Timestamp request
}

4XX  error

{
  status: "error",
  message: "Error explanation" // Eg: Missing API token
  code: "error_code" // Eg: no_token
}

Possible error codes

  • no_token
  • no_list_uuid
  • invalid_list_or_token
  • no_email_address
  • subscriber_not_found
  • too_many_calls

Still need help? Contact Us Contact Us