Search registrations

GET

/v1/communications

const url = 'https://api.fromenance.com/v1/communications?status=registered';
const options = {
  method: 'GET',
  headers: {cookie: 'fromenance.session_token=<fromenance.session_token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.fromenance.com/v1/communications?status=registered' \
  --cookie fromenance.session_token=<fromenance.session_token>

Authorizations

Session
ApiKey
read

Parameters

Query Parameters

code

string

message_id

string

template_id

string

status

string

Allowed values: registered reserved expired

source_id

string

from

string format: date-time

limit

string

Responses

200

Communications

application/json

object

data

required

Array<object>

object

required

string

channel

required

string

status

required

string

recipient_hash

required

string | null

message_id

required

string | null

from_address

required

string | null

sent_at

required

string | null

verify_code

required

string

subject_fingerprint

required

string | null

content_fingerprint

required

object

simhash

required

string

/^0x[0-9a-fA-F]{1,16}$/

sha256

required

string

/^[0-9a-f]{64}$/

link_domains

required

Array<string>

template_id

required

string | null

campaign_id

required

string | null

provider

required

string | null

source_id

required

string | null

retro

required

boolean

sandbox

required

boolean

reserved_at

required

string | null

completed_at

required

string | null

expires_at

required

string

created_at

required

string

verifications

Array<object>

object

submission_id

required

string

outcome

required

string

rule

required

string

received_at

required

string

Example

{
  "data": [
    {
      "content_fingerprint": {
        "simhash": "0x9a4d3c2b1f0e8d7c"
      }
    }
  ]
}