Get Event

Get an Event by its (event) id, the event must have been created by the system and you must be the owner of the the event, you can get an event id by either listing events or via a webhook integration.

GET /events/{id}

Get Event

cURL

curl --request GET \
  --url https://api.paxos.com/v2/events/{id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.paxos.com/v2/events/{id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.paxos.com/v2/events/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.paxos.com/v2/events/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.paxos.com/v2/events/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.paxos.com/v2/events/{id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.paxos.com/v2/events/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "id": "d99a03ee-6b88-4362-89da-087c2c8cd4a7",
  "type": "identity.approved",
  "object_type": "identity_summary_status_change",
  "object": {
    "id": "d840cf31-352f-4190-a476-7522bf3eafda",
    "identity_id": "4fd025ab-f29f-47e6-a02e-df90a61c7ec9",
    "new_summary_status": "APPROVED",
    "old_summary_status": "PENDING"
  },
  "created_at": "2023-08-25T14:25:41.648489333Z",
  "undelivered_webhooks": 0
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "status": 400,
  "detail": "error parsing event id"
}

{
  "type": "about:blank",
  "title": "Forbidden",
  "status": 403,
  "detail": "insufficient scopes: found 'identity:read_identity', required one of '[event:read_event]'"
}

{
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

OAuth Scope

events:read_event

Authorizations

Authorization · string · header · required

Paxos APIs use OAuth 2 with the client credentials grant flow.

Token URLs:

• Production: https://oauth.paxos.com/oauth2/token
• Sandbox: https://oauth.sandbox.paxos.com/oauth2/token

Learn more in the API credentials guide →

Path Parameters

id · string · required

The unique id in the Event object.

Query Parameters

is_test · boolean

Filter for test events (true) or real events (false). Defaults to false (real events only).

Response

200

application/json

Success

id · string

type · string

object_type · string

object · The structured payload of type `object_type` associated with the event · object

created_at · string<date-time>

The timestamp when the event was first created, RFC3339 format, like YYYY-MM-DDTHH:MM:SS.sssZ.

undelivered_webhooks · integer<int32>