Get Document by ID

Test API endpoints in real-time

Request

Query Parameters

Response

Click Send to get a response

1. Endpoint Details

Endpoint Details

HTTP Method

GET

Endpoint URL

/api/v1/apiwarehouse/{document_id}

2. Path Parameters

document_idstring (required)

The unique identifier of the document to retrieve

3. Required Headers

acceptapplication/json

x-api-keyYour API authentication key

4. Example Request

Bash

curl --location 'https://api.swellsign.com/api/v1/apiwarehouse/68ebbdf34746d9852df3b0c5'
--header 'Accept: application/json'
--header 'x-api-key: xWuCfym7ad5f674t3ry7aDpZ3gDJwtE34Ib9raiPEM5xk6IMLBz6gA'

4. Example Response

Json

{
"id": "68ebbdf34746d9852df3b0c5",
"name": "frec",
"status": "draft",
"file_url": "https://propelatech-swellsign.s3.amazonaws.com/68ebbdf34746d9852df3b0c5/frec",
"organization": {
  "id": "686d7644b179e714014d9025",
  "name": "Sukrut Associates"
},
"created_by": {
  "id": "686e00764347ec9cdcd9d8fe",
  "name": "Neeraj Sharma",
  "email": "neeraj.dev@thesukrut.com"
},
"template": {
  "id": "68eb9dbc4746d9852df3a85b",
  "name": "684d63594146454d9830f0b7_7_1 (cloned).pdf"
},
"created_at": "2025-10-12T14:40:51.531Z",
"updated_at": "2025-10-12T14:40:54.756Z",
"expires_at": "2025-10-23T18:29:59.000Z"
}

5. Response Fields

idstring

Unique document identifier

namestring

Document name/title

statusstring

Current document status (draft, sent, complete, expired)

final_urlstring

S3 URL to access the document file

organizationobject

Organization details including ID and name

created_byobject

Creator information including ID, name, and email

templateobject

Template information including ID and name used to create this document

created_atstring (ISO date)

Timestamp when the document was created

updated_atstring (ISO date)

Timestamp when the document was last updated

expires_atstring (ISO date)

Expiration date and time for the document