Get a Signature Request

get/public/v1/signature-requests/{signatureRequest}

get/public/v1/signature-requests/{signatureRequest}

curl --request GET \
  --url 'https://api.app.astalty.com.au/public/v1/signature-requests/{signatureRequest}' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Accept: application/json'

Response

{
  "data": {
    "id": "s1i2g3n4-a5t6-47u8-9r0e-1b2c3d4e5f6a",
    "title": "Service Agreement",
    "status": "awaiting_signatures",
    "platform": "docusign",
    "is_test": false,
    "expires_at": "2024-02-15T00:00:00+00:00",
    "created_at": "2024-01-15T10:30:00+00:00",
    "owner": {
      "type": "participant",
      "id": "p1a2r3t4-c5d6-47e8-9f0a-1b2c3d4e5f6a",
      "name": "John Doe"
    },
    "requested_by": {
      "id": "u1s2e3r4-a5b6-47c8-9d0e-1f2a3b4c5d6e",
      "name": "John Doe"
    }
  }
}

Authorization

Authorizationstringrequired
Bearer authentication header of the form Bearer <token>, where <token> is your API key. See How to set up an API key.

Path parameters

signatureRequeststringrequired
The signature request UUID

Response

200application/json

SignatureRequestResource

dataobjectrequired
▶Show 9 child attributesHide child attributes
- idstringrequired
  Example:s1i2g3n4-a5t6-47u8-9r0e-1b2c3d4e5f6a
- titlestringrequired
  Example:Service Agreement
- statusstringrequired
  Example:awaiting_signatures
- platformstringrequired
  Example:docusign
- is_testbooleanrequired
  Example:false
- expires_atstring | nullrequired
  Example:2024-02-15T00:00:00+00:00
- created_atstringrequired
  Example:2024-01-15T10:30:00+00:00
- ownerobject | nullrequired
  ▶Show 3 child attributesHide child attributes
  typestring | nullrequired
  Example:participant
  idstringrequired
  Example:p1a2r3t4-c5d6-47e8-9f0a-1b2c3d4e5f6a
  namestringrequired
  Example:John Doe
- requested_byobject | nullrequired
  ▶Show 2 child attributesHide child attributes
  idstringrequired
  Example:u1s2e3r4-a5b6-47c8-9d0e-1f2a3b4c5d6e
  namestringrequired
  Example:John Doe

Errors

401Unauthenticated
403Authorization error
404Not found

Command Palette

Authorization

Path parameters

Response

Errors