Get a contract

GET/v1/organization/{orgId}/crm/contracts/{contractId}

US Region: https://public-api.sessionboard.com · EU Region: https://public-api-eu.sessionboard.com

One contract with each signer's role, name, email, status and signing time, and its history. Reads only. Requires read:crm. Refused for a key restricted to particular events. Also at GET /v1/org/{orgId}/crm/contracts/{contractId}, and at GET /v1/crm/contracts/{contractId} with the organization taken from the token.

Request example

curl --request GET \
  --url 'https://public-api.sessionboard.com/v1/organization/{orgId}/crm/contracts/{contractId}' \
  --header 'x-access-token: <api-token>'

const response = await fetch('https://public-api.sessionboard.com/v1/organization/{orgId}/crm/contracts/{contractId}', {
  method: 'GET',
  headers: {
    "x-access-token": "<api-token>"
  },
});

const data = await response.json();
console.log(data);

import requests

response = requests.request(
    "GET",
    "https://public-api.sessionboard.com/v1/organization/{orgId}/crm/contracts/{contractId}",
    headers={
        "x-access-token": "<api-token>"
    },
)

print(response.json())

<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://public-api.sessionboard.com/v1/organization/{orgId}/crm/contracts/{contractId}",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "x-access-token: <api-token>",
    ],
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;

package main

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

func main() {
  req, _ := http.NewRequest("GET", "https://public-api.sessionboard.com/v1/organization/{orgId}/crm/contracts/{contractId}", nil)
  req.Header.Add("x-access-token", "<api-token>")

  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(string(body))
}

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://public-api.sessionboard.com/v1/organization/{orgId}/crm/contracts/{contractId}"))
    .header("x-access-token", "<api-token>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

HttpResponse<String> response = HttpClient.newHttpClient()
    .send(request, HttpResponse.BodyHandlers.ofString());

System.out.println(response.body());

Try it

Response headers

Authorizations

x-access-tokenstringheader
Organization API token. Generate from Organization Settings → API Tokens.
AuthorizationBearer <token>headeror
OAuth 2.1 access token. Obtained via the OAuth PKCE flow at /oauth/token.

Send one of these. See Authentication.

Path parameters

orgIdstringpathrequired
Your organization ID. Any other organization returns 404.
contractIdstringpathrequired
The contract ID.

Responses

200`application/json`

successboolean
payloadCrmContractDetail
Show child attributes
- idstring
- titlestring
- statusstring
  delivered: the signer opened the signing page. completed: everyone signed.
  Allowed values
  "created", "sent", "delivered", "completed", "declined", "voided"
- sourcestring
  How it was sent: native is Sessionboard e-sign.
- contactobject | null
  Show child attributes
  - idstring
  - namestring
  - emailstring<email>
- templateobject | null
  Show child attributes
  - idstring
  - namestring
- signer_emailstring<email> | null
- has_pdfboolean
  The signed PDF is ready.
- sent_atstring<date-time> | null
- signed_atstring<date-time> | null
- voided_atstring<date-time> | null
- updated_atstring<date-time>
- signersobject[]
  Show child attributes
  - role_keystring
  - role_labelstring
  - namestring
  - emailstring<email>
  - statusstring
  - signing_orderinteger
  - viewed_atstring<date-time> | null
  - signed_atstring<date-time> | null
  - declined_atstring<date-time> | null
- historyobject[]
  Show child attributes
  - kindstring
  - atstring<date-time>
  - actorstring | null
  - reasonstring | null

401

Missing, invalid or expired token.

403`application/json`

SCOPE_REQUIRED: the token lacks read:crm.
ORG_WIDE_TOKEN_REQUIRED: the key is restricted to particular events; use a key without an event restriction.
FORBIDDEN: the token's user cannot read the organization's contacts.

successboolean
errorstring
Allowed values
"VALIDATION_ERROR", "SCOPE_REQUIRED", "ORG_WIDE_TOKEN_REQUIRED", "FORBIDDEN", "NOT_FOUND", "CONFLICT", "QUOTA_EXCEEDED"
codestring
A more specific reason: exists, read_only, platform_customer.
messagestringrequired
contactCrmContact
With code: exists: the contact that has the email.
Show child attributes
- idstring
- first_namestring
- last_namestring | null
- namestring
- emailstring<email>
- companystring | null
- titlestring | null
  Job title.
- avatar_urlstring | null
- typesstring[]
  Allowed values
  "speaker", "sme", "influencer", "exhibitor", "sponsor"
- tagsCrmTag[]
  Show child attributes
  - idstring
  - namestring
- events_countinteger
- sessions_countinteger
- last_activity_atstring<date-time> | null
- activeboolean
  An active contact in the last 365 days.
- sourcestring | null
  Where the contact came from.
- created_atstring<date-time>
- hrefstring
  The contact in Sessionboard CRM.
- stageobject | null
  The contact's pipeline stage; null when not in the pipeline.
  Show child attributes
  - idstring
  - labelstring

404`application/json`

NOT_FOUND: orgId is not the token's organization, or the contact, tag or app is not in it.

successboolean
errorstring
Allowed values
"VALIDATION_ERROR", "SCOPE_REQUIRED", "ORG_WIDE_TOKEN_REQUIRED", "FORBIDDEN", "NOT_FOUND", "CONFLICT", "QUOTA_EXCEEDED"
codestring
A more specific reason: exists, read_only, platform_customer.
messagestringrequired
contactCrmContact
With code: exists: the contact that has the email.
Show child attributes
- idstring
- first_namestring
- last_namestring | null
- namestring
- emailstring<email>
- companystring | null
- titlestring | null
  Job title.
- avatar_urlstring | null
- typesstring[]
  Allowed values
  "speaker", "sme", "influencer", "exhibitor", "sponsor"
- tagsCrmTag[]
  Show child attributes
  - idstring
  - namestring
- events_countinteger
- sessions_countinteger
- last_activity_atstring<date-time> | null
- activeboolean
  An active contact in the last 365 days.
- sourcestring | null
  Where the contact came from.
- created_atstring<date-time>
- hrefstring
  The contact in Sessionboard CRM.
- stageobject | null
  The contact's pipeline stage; null when not in the pipeline.
  Show child attributes
  - idstring
  - labelstring

429

The token's request limit (100 requests per 15 minutes by default) or, for writes, its daily write quota. Wait Retry-After seconds.

Retry-Afterintegerheader
Seconds to wait before retrying.

Response examples

{
  "success": true,
  "payload": {
    "id": "<string>",
    "title": "<string>",
    "status": "created",
    "source": "<string>",
    "contact": {
      "id": "<string>",
      "name": "<string>",
      "email": "jane@example.com"
    },
    "template": {
      "id": "<string>",
      "name": "<string>"
    },
    "signer_email": "jane@example.com",
    "has_pdf": true,
    "sent_at": "2026-01-15T09:30:00Z",
    "signed_at": "2026-01-15T09:30:00Z",
    "voided_at": "2026-01-15T09:30:00Z",
    "updated_at": "2026-01-15T09:30:00Z",
    "signers": [
      {
        "role_key": "<string>",
        "role_label": "<string>",
        "name": "<string>",
        "email": "jane@example.com",
        "status": "<string>",
        "signing_order": 123,
        "viewed_at": "2026-01-15T09:30:00Z",
        "signed_at": "2026-01-15T09:30:00Z",
        "declined_at": "2026-01-15T09:30:00Z"
      }
    ],
    "history": [
      {
        "kind": "<string>",
        "at": "2026-01-15T09:30:00Z",
        "actor": "<string>",
        "reason": "<string>"
      }
    ]
  }
}

{
  "success": false,
  "error": "VALIDATION_ERROR",
  "code": "<string>",
  "message": "<string>",
  "contact": {
    "id": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "name": "<string>",
    "email": "jane@example.com",
    "company": "<string>",
    "title": "<string>",
    "avatar_url": "<string>",
    "types": [
      "speaker"
    ],
    "tags": [
      {
        "id": "<string>",
        "name": "<string>"
      }
    ],
    "events_count": 123,
    "sessions_count": 123,
    "last_activity_at": "2026-01-15T09:30:00Z",
    "active": true,
    "source": "<string>",
    "created_at": "2026-01-15T09:30:00Z",
    "href": "<string>",
    "stage": {
      "id": "<string>",
      "label": "<string>"
    }
  }
}

{
  "success": false,
  "error": "VALIDATION_ERROR",
  "code": "<string>",
  "message": "<string>",
  "contact": {
    "id": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "name": "<string>",
    "email": "jane@example.com",
    "company": "<string>",
    "title": "<string>",
    "avatar_url": "<string>",
    "types": [
      "speaker"
    ],
    "tags": [
      {
        "id": "<string>",
        "name": "<string>"
      }
    ],
    "events_count": 123,
    "sessions_count": 123,
    "last_activity_at": "2026-01-15T09:30:00Z",
    "active": true,
    "source": "<string>",
    "created_at": "2026-01-15T09:30:00Z",
    "href": "<string>",
    "stage": {
      "id": "<string>",
      "label": "<string>"
    }
  }
}