Documentation | API | Endpoints | Note | Read
NoteRead

The endpoint allows you to read all the notes added to a client's profile. To identify profile/client a valid combination of email_address and mobile_number is required. A json object is required to be posted as raw body. See example request, response objects and authentication process. The full API URL is :

POST https://authified.com/api/v1/note/read

Query Parameters
Name Type Description
/email_address string(45) A valid email address, unique for each customer - (required)
/mobile_number string(10) A valid US/CAN 10 digit, without country code mobile phone number, unique for each customer - (required)
/offset int A valid integer offset value - (optional)
/limit int A valid integer value in between 1 to 50 - (optional)
Please, to send request.
{
    "email_address": "",
    "mobile_number": "",
    "offset": 0,
    "limit": 10
}
{
    "http_status_code": 200,
    "query_reference_id": "",
    "response_time": 0,
    "query_at": "",
    "total_count": 0,
    "offset": 0,
    "limit": 0,
    "filtered": 0,
    "email_address": "",
    "mobile_number": "",
    "notes": [
        {
            "note": "",
            "created_at": ""
        }
    ]
}

Last modified: 4 years ago
curl --location --request POST 'https://authified.com/api/v1/note/read' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Api-Key: ' \
--header 'Signature: ' \
--data-raw '{
    "email_address": "",
    "mobile_number": "",
    "offset": 0,
    "limit": 10,
}'
POST /api/v1/note/read HTTP/1.1
Host: https://authified.com
Accept: application/json
Content-Type: application/json
Api-Key: 
Signature: 
Content-Length: 
{
    "email_address": "",
    "mobile_number": "",
    "offset": 0,
    "limit": 10,
}
var settings = {
    "url": "https://authified.com/api/v1/note/read",
    "method": "POST",
    "timeout": 0,
    "headers": {
      "Accept": "application/json",
      "Content-Type": "application/json",
      "Api-Key": "",
      "Signature": ""
    },
    "data": JSON.stringify({"email_address":"","mobile_number":"","offset":0,"limit":10}),
  };
  
  $.ajax(settings).done(function (response) {
    console.log(response);
  });
var data = JSON.stringify({"email_address":"","mobile_number":"","offset":0,"limit":10});

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function() {
  if(this.readyState === 4) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://authified.com/api/v1/note/read");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.setRequestHeader("Api-Key", "");
xhr.setRequestHeader("Signature", "");

xhr.send(data);
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
  CURLOPT_URL => "https://authified.com/api/v1/note/read",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS =>'{
    "email_address": "",
    "mobile_number": "",
    "offset": 0,
    "limit": 10,
}',
  CURLOPT_HTTPHEADER => array(
    "Accept: application/json",
    "Content-Type: application/json",
    "Api-Key: ",
    "Signature: "
  ),
));
$response = curl_exec($curl);
$http_code = curl_getinfo($url, CURLINFO_HTTP_CODE);
curl_close($url);
if ($http_code === 200):
    echo $response;
else:
    echo "Un-expected server response http_code($http_code)<br/>$response";
endif;
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://authified.com/api/v1/note/read');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Accept' => 'application/json',
  'Content-Type' => 'application/json',
  'Api-Key' => '',
  'Signature' => ''
));
$request->setBody('{\n "email_address": "",\n "mobile_number": "",\n "offset": 0,\n "limit": 10}');
try {
  $response = $request->send();
  if ($response->getStatus() === 200) {
    echo $response->getBody();
  }
  else {
    echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
    $response->getReasonPhrase();
  }
}
catch(HTTP_Request2_Exception $e) {
  echo 'Error: ' . $e->getMessage();
}