Retrieve

Retrieve

curl --request GET \
  --url https://api.cadanapay.com/v1/contracts/{contractId} \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.cadanapay.com/v1/contracts/{contractId}', 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.cadanapay.com/v1/contracts/{contractId}",
  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.cadanapay.com/v1/contracts/{contractId}"

	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://api.cadanapay.com/v1/contracts/{contractId}")

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": "8ef9a712-cdae-4110-b1ea-9ba95abbee6e",
  "templateId": "8ef9a712-cdae-4110-b1ea-9ba95abbee6e",
  "status": "completed",
  "personId": "8ef9a712-cdae-4110-b1ea-9ba95abbee6e",
  "name": "Edward Petersen - Standard Global Contractor Agreement",
  "signatures": [
    {
      "id": "8ef9a712-cdae-4110-b1ea-9ba95abbee6e",
      "emailAddress": "signer@example.com",
      "name": "John Doe",
      "order": 0,
      "status": "signed",
      "signedAt": 1689759850,
      "lastViewedAt": 1689759850
    }
  ],
  "createdAt": 1689759850,
  "customContractAttached": false,
  "downloadUrl": "https://storage.example.com/contracts/d52e4a13-7b6f-4c8d-a9e1-2f3b5c7d8e9a.pdf?token=abc123&expires=900",
  "downloadUrlExpiresAt": 1689760750
}

{
  "code": "resource_not_found",
  "message": "Requested resource could not be found."
}

GET

contracts

{contractId}

Retrieve

curl --request GET \
  --url https://api.cadanapay.com/v1/contracts/{contractId} \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.cadanapay.com/v1/contracts/{contractId}', 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.cadanapay.com/v1/contracts/{contractId}",
  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.cadanapay.com/v1/contracts/{contractId}"

	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://api.cadanapay.com/v1/contracts/{contractId}")

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": "8ef9a712-cdae-4110-b1ea-9ba95abbee6e",
  "templateId": "8ef9a712-cdae-4110-b1ea-9ba95abbee6e",
  "status": "completed",
  "personId": "8ef9a712-cdae-4110-b1ea-9ba95abbee6e",
  "name": "Edward Petersen - Standard Global Contractor Agreement",
  "signatures": [
    {
      "id": "8ef9a712-cdae-4110-b1ea-9ba95abbee6e",
      "emailAddress": "signer@example.com",
      "name": "John Doe",
      "order": 0,
      "status": "signed",
      "signedAt": 1689759850,
      "lastViewedAt": 1689759850
    }
  ],
  "createdAt": 1689759850,
  "customContractAttached": false,
  "downloadUrl": "https://storage.example.com/contracts/d52e4a13-7b6f-4c8d-a9e1-2f3b5c7d8e9a.pdf?token=abc123&expires=900",
  "downloadUrlExpiresAt": 1689760750
}

{
  "code": "resource_not_found",
  "message": "Requested resource could not be found."
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-MultiTenantKey

string

Required when using a Platform API token. The tenant key identifying which business to operate on.

Path Parameters

contractId

string<uuid>

required

The unique identifier for the the contract

Query Parameters

includeDownloadUrl

boolean

default:false

When true, includes a presigned download URL for the contract PDF (valid for 15 minutes)

Response

retrieve contract response

string<uuid>

Example:

"8ef9a712-cdae-4110-b1ea-9ba95abbee6e"

templateId

string<uuid>

Example:

"8ef9a712-cdae-4110-b1ea-9ba95abbee6e"

status

string

Example:

"completed"

personId

string<uuid>

Example:

"8ef9a712-cdae-4110-b1ea-9ba95abbee6e"

name

string

Example:

"Edward Petersen - Standard Global Contractor Agreement"

signatures

object[]

Show child attributes

createdAt

integer

Example:

1689759850

customContractAttached

boolean

Example:

false

downloadUrl

string

Presigned S3 download URL for the contract PDF. Only included when includeDownloadUrl=true.

Example:

"https://storage.example.com/contracts/d52e4a13-7b6f-4c8d-a9e1-2f3b5c7d8e9a.pdf?token=abc123&expires=900"

downloadUrlExpiresAt

integer

Epoch timestamp when the download URL expires. Only included when includeDownloadUrl=true.

Example:

1689760750

Create

Signing URL

⌘I

Overview

Payments API

Wallets API

Workforce API

Tax API

Statutory Compliance API

Authorizations

Headers

Path Parameters

Query Parameters

Response