Skip to main content
GET
/
api
/
v1
/
esign
/
bundle
/
{id}
Get e-sign bundle
curl --request GET \
  --url https://api.noux.app/api/v1/esign/bundle/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'authorization: <authorization>'
{
  "bundleId": "<string>",
  "bundleName": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "roomId": "<string>",
  "roomName": "<string>",
  "owner": {
    "id": "<string>",
    "email": "jsmith@example.com",
    "firstName": "<string>",
    "lastName": "<string>"
  },
  "signers": [
    {
      "id": "<string>",
      "email": "jsmith@example.com",
      "firstName": "<string>",
      "lastName": "<string>",
      "signedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "completion": {
    "completionId": "<string>",
    "completedAt": "2023-11-07T05:31:56Z"
  },
  "documents": [
    {
      "name": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "signable": true,
      "isCompletionDocument": true,
      "source": {
        "kind": "file",
        "originalUrl": "<string>",
        "mimeType": "<string>",
        "fileSize": 123
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

Noux API key from your integration settings

Headers

authorization
string
required

Bearer token with Noux API key

Path Parameters

id
string
required

The e-sign bundle ID to retrieve

Response

E-sign bundle retrieved successfully

bundleId
string
required
status
enum<string>
required
Available options:
Draft,
PendingSigners,
AllSigned,
Completed,
Voided
bundleName
string
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
roomId
string | null
required
roomName
string | null
required
owner
object
required
signers
object[]
required
completion
object
required
documents
object[]
required