Get an event

GET

api

events

{id}

Get an event

curl --request GET \
  --url https://app.sajn.se/api/v1/events/{id} \
  --header 'Authorization: Bearer <token>'

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

fetch('https://app.sajn.se/api/v1/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://app.sajn.se/api/v1/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://app.sajn.se/api/v1/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))

}

require 'uri'
require 'net/http'

url = URI("https://app.sajn.se/api/v1/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

{
  "id": "cm4k2x9p10014abcd1234efgh",
  "type": "document.created",
  "createdAt": "2026-09-28T09:12:00.000Z",
  "apiVersion": "2026-10",
  "workspaceId": "cm4k2x9p10001abcd1234efgh",
  "environment": "PRODUCTION",
  "actor": {
    "type": "USER",
    "id": "cm4k2x9p10014abcd1234efgh"
  },
  "data": {
    "partyId": "cm4k2x9p10004abcd1234efgh",
    "signatureType": "SE_BANKID"
  }
}

{
  "code": "INVALID_API_VERSION",
  "message": "Unknown API version \"2026-13\". Supported versions: 2026-09, 2026-10.",
  "userMessage": "API-versionen finns inte.",
  "requestId": "req_V1StGXR8Z5jdHi6BmyT2"
}

{
  "code": "UNAUTHORIZED",
  "message": "Invalid API token",
  "userMessage": "Ogiltig API-nyckel",
  "requestId": "req_V1StGXR8Z5jdHi6BmyT2"
}

{
  "code": "INSUFFICIENT_SCOPE",
  "message": "Insufficient OAuth scope: requires webhooks:read",
  "userMessage": "Applikationen saknar behörighet (scope) för denna åtgärd.",
  "requestId": "req_V1StGXR8Z5jdHi6BmyT2",
  "requiredScopes": [
    "webhooks:read"
  ],
  "grantedScopes": [
    "profile:read"
  ]
}

{
  "code": "NOT_FOUND",
  "message": "Event not found",
  "userMessage": "Resursen hittades inte.",
  "requestId": "req_V1StGXR8Z5jdHi6BmyT2",
  "resource": "event"
}

{
  "code": "INVALID_STATE",
  "message": "The resource's current state doesn't allow the operation, such as editing a document that was already sent or downloading a file that isn't produced yet.",
  "userMessage": "Åtgärden är inte möjlig i resursens nuvarande status.",
  "requestId": "req_V1StGXR8Z5jdHi6BmyT2"
}

{
  "code": "RATE_LIMITED",
  "message": "API rate limit exceeded",
  "userMessage": "För många förfrågningar. Försök igen om en stund.",
  "requestId": "req_V1StGXR8Z5jdHi6BmyT2"
}

{
  "code": "INTERNAL_ERROR",
  "message": "Internal server error",
  "userMessage": "Något gick fel.",
  "requestId": "req_V1StGXR8Z5jdHi6BmyT2"
}

{
  "code": "UPSTREAM_UNAVAILABLE",
  "message": "A service the operation depends on, such as an eID provider or a connected integration, failed or is unavailable. Retry with exponential backoff.",
  "userMessage": "En extern tjänst svarar inte just nu. Försök igen om en stund.",
  "requestId": "req_V1StGXR8Z5jdHi6BmyT2"
}

Authorizations

Authorization

string

header

required

API key, e.g. Authorization: Bearer sajn_svc_.... Not scope-limited: acts with its owner's workspace role.

Headers

Sajn-Version

enum<string>

API version for this request. Without it, the request uses the organization's default version; an organization without a default is pinned to the latest version by its first request.

Available options:

2026-09,

2026-10

Sajn-Workspace

string

ID of the workspace this request acts in, from GET /api/v1/workspaces. Without it, an API key acts in its default workspace. The token's user must be a member of the workspace; an OAuth token only accepts the workspace it was granted for. A workspace that doesn't exist or can't be reached returns 403 WORKSPACE_ACCESS_DENIED.

Path Parameters

string

required

The event ID.

Response

200

string

required

Event ID. Every delivery of the event carries it in the body and the webhook-id header.

type

enum<string>

required

The event type, such as document.completed.

Available options:

document.created,

document.sent,

document.fully_signed,

document.completed,

document.rejected,

document.expired,

document.withdrawn,

document.updated,

document.deleted,

document.restored,

document.archived,

document.unarchived,

document.expiration_extended,

document.expiring_soon,

document.party.sent,

document.party.delivery_failed,

document.party.opened,

document.party.read,

document.party.signed,

document.party.rejected,

document.party.delegated,

document.party.auth_failed,

document.party.verified,

document.party.updated,

document.party.added,

document.party.removed,

document.party.reminded,

document.comment.created,

bundle.sent,

bundle.party.signed,

bundle.completed,

bundle.cancelled,

archive_import.completed,

archive_import.undone,

identity_check.created,

identity_check.sent,

identity_check.opened,

identity_check.verified,

identity_check.failed,

identity_check.cancelled,

contact.created,

contact.updated,

contact.deleted,

company.created,

company.updated,

company.deleted,

template.created,

template.updated,

template.deleted,

template.restored,

form.submitted,

workspace.created,

member.added,

member.invited,

member.invite_accepted,

approval_request.created,

approval_request.approved,

approval_request.rejected,

approval_request.cancelled,

login.completed,

login.failed,

security.document_downloaded,

security.documents_exported,

security.signature_identity_accessed,

security.member_removed,

security.member_role_changed,

security.role_updated,

security.workspace_retention_updated,

usage.limit_reached

createdAt

string<date-time>

required

When the event happened.

apiVersion

string

required

The API version that sets the shape of data.

workspaceId

string

required

The workspace ID.

environment

enum<string>

required

SANDBOX for an event in a sandbox organization.

Available options:

PRODUCTION,

SANDBOX

actor

object | null

required

Who caused the event. Null when sajn can't attribute it: a party's action, such as signing, and most changes made in the sajn app.

Show child attributes

data

object

required

The event's data, the same object a webhook delivery carries. object is the resource the event is about; the other fields depend on type.

Example:

{
  "object": {
    "id": "cm4k2x9p10003abcd1234efgh",
    "externalId": "HR-2026-0142",
    "expiresAt": "2026-10-28T22:00:00.000Z",
    "name": "Anställningsavtal – Kai Lindqvist",
    "status": "PENDING",
    "documentMeta": {
      "subject": "Ditt anställningsavtal från Exempelbolaget AB",
      "message": "Hej Kai! Här är ditt anställningsavtal. Signera det med BankID senast den 28 oktober.",
      "signingMode": "PARALLEL",
      "forceReadFullDocument": true,
      "showChatToSigners": false,
      "language": "sv",
      "value": null,
      "redirectUrl": null,
      "redirectEnabled": false,
      "internalRecipients": ["[email protected]"],
      "signableAfterExpired": false,
      "sendPlainTextEmailOnly": null,
      "reminderIntervalDays": 3,
      "allowDelegation": false,
      "openVerification": null,
      "aiChatEnabled": null,
      "nationalIdDisplayMode": null,
      "sameDeviceSigning": false,
      "documentCategoryId": "cm4k2x9p10017abcd1234efgh"
    },
    "createdAt": "2026-09-28T09:12:00.000Z",
    "updatedAt": "2026-09-29T07:41:00.000Z",
    "completedAt": null,
    "deletedAt": null,
    "templateId": "cm4k2x9p10008abcd1234efgh",
    "folderId": "cm4k2x9p10011abcd1234efgh",
    "responsibleUserId": "cm4k2x9p10002abcd1234efgh",
    "parties": [
      {
        "id": "cm4k2x9p10004abcd1234efgh",
        "documentId": "cm4k2x9p10003abcd1234efgh",
        "email": "[email protected]",
        "name": "Kai Lindqvist",
        "phone": "+46701740605",
        "type": "INDIVIDUAL",
        "company": null,
        "externalId": "EMP-0142",
        "contactId": "cm4k2x9p10006abcd1234efgh",
        "nationalId": null,
        "country": "SE",
        "role": "SIGNER",
        "signingOrder": 1,
        "signedAt": "2026-09-29T07:41:00.000Z",
        "readStatus": "READ",
        "signingStatus": "SIGNED",
        "delivery": ["EMAIL"],
        "signatureMethod": "SE_BANKID",
        "signVerification": null,
        "openVerification": null,
        "sendStatus": "DELIVERED",
        "identityVerified": true,
        "identityMismatch": false,
        "createdAt": "2026-09-28T09:12:00.000Z"
      }
    ],
    "tags": [],
    "customFields": [],
    "content": null,
    "productTables": [],
    "approvalRequestId": null,
    "bundleId": null
  }
}

Get an event

curl --request GET \
  --url https://app.sajn.se/api/v1/events/{id} \
  --header 'Authorization: Bearer <token>'

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

fetch('https://app.sajn.se/api/v1/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://app.sajn.se/api/v1/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://app.sajn.se/api/v1/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))

}

require 'uri'
require 'net/http'

url = URI("https://app.sajn.se/api/v1/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

{
  "id": "cm4k2x9p10014abcd1234efgh",
  "type": "document.created",
  "createdAt": "2026-09-28T09:12:00.000Z",
  "apiVersion": "2026-10",
  "workspaceId": "cm4k2x9p10001abcd1234efgh",
  "environment": "PRODUCTION",
  "actor": {
    "type": "USER",
    "id": "cm4k2x9p10014abcd1234efgh"
  },
  "data": {
    "partyId": "cm4k2x9p10004abcd1234efgh",
    "signatureType": "SE_BANKID"
  }
}

{
  "code": "INVALID_API_VERSION",
  "message": "Unknown API version \"2026-13\". Supported versions: 2026-09, 2026-10.",
  "userMessage": "API-versionen finns inte.",
  "requestId": "req_V1StGXR8Z5jdHi6BmyT2"
}

{
  "code": "UNAUTHORIZED",
  "message": "Invalid API token",
  "userMessage": "Ogiltig API-nyckel",
  "requestId": "req_V1StGXR8Z5jdHi6BmyT2"
}

{
  "code": "INSUFFICIENT_SCOPE",
  "message": "Insufficient OAuth scope: requires webhooks:read",
  "userMessage": "Applikationen saknar behörighet (scope) för denna åtgärd.",
  "requestId": "req_V1StGXR8Z5jdHi6BmyT2",
  "requiredScopes": [
    "webhooks:read"
  ],
  "grantedScopes": [
    "profile:read"
  ]
}

{
  "code": "NOT_FOUND",
  "message": "Event not found",
  "userMessage": "Resursen hittades inte.",
  "requestId": "req_V1StGXR8Z5jdHi6BmyT2",
  "resource": "event"
}

{
  "code": "INVALID_STATE",
  "message": "The resource's current state doesn't allow the operation, such as editing a document that was already sent or downloading a file that isn't produced yet.",
  "userMessage": "Åtgärden är inte möjlig i resursens nuvarande status.",
  "requestId": "req_V1StGXR8Z5jdHi6BmyT2"
}

{
  "code": "RATE_LIMITED",
  "message": "API rate limit exceeded",
  "userMessage": "För många förfrågningar. Försök igen om en stund.",
  "requestId": "req_V1StGXR8Z5jdHi6BmyT2"
}

{
  "code": "INTERNAL_ERROR",
  "message": "Internal server error",
  "userMessage": "Något gick fel.",
  "requestId": "req_V1StGXR8Z5jdHi6BmyT2"
}

{
  "code": "UPSTREAM_UNAVAILABLE",
  "message": "A service the operation depends on, such as an eID provider or a connected integration, failed or is unavailable. Retry with exponential backoff.",
  "userMessage": "En extern tjänst svarar inte just nu. Försök igen om en stund.",
  "requestId": "req_V1StGXR8Z5jdHi6BmyT2"
}

Get started

Core concepts

Guides

Webhooks

API fundamentals

Upgrading

sajn Login

API reference

Get an event

Authorizations

Headers

Path Parameters

Response