Get All Completed Documents

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/all-completed/documents

2. Required Headers

Required Headers

acceptapplication/json

x-api-keyYour API authentication key

3. Example Request

Bash

curl --location 'https://api.swellsign.com/api/v1/apiwarehouse/all-completed/documents'
--header 'accept: application/json'
--header 'x-api-key: xWuCfym7ad5f674t3ry7aDpZ3gDJwtE34Ib9raiPEM5xk6IMLBz6gA'

3. Example Response

Json

{
"success": true,
"totalItems": 144,
"totalPages": 15,
"currentPage": 1,
"itemsonPage": 10,
"items": [
  {
    "document_id": "68a9fd6f3c9f273678b515bc",
    "document_name": "Test",
    "created_by": "686e00764347ec9cdcd9d8fe",
    "organization": "686d7644b179e714014d9025",
    "template_id": "68a9ac7b2f4a4437942ae5d8",
    "status": "complete",
    "is_expired": false,
    "expires_at": "2025-08-30T00:00:00.000Z",
    "created_at": "2025-08-23T17:42:07.467Z",
    "updated_at": "2025-08-23T17:47:22.760Z"
  },
  {
    "document_id": "68a9fc3f3c9f273678b514b4",
    "document_name": "Test",
    "created_by": "686e00764347ec9cdcd9d8fe",
    "organization": "686d7644b179e714014d9025",
    "template_id": "68a9ac7b2f4a4437942ae5d8",
    "status": "complete",
    "is_expired": false,
    "expires_at": "2025-08-30T00:00:00.000Z",
    "created_at": "2025-08-23T17:37:03.750Z",
    "updated_at": "2025-08-23T17:37:55.160Z"
  },
  {
    "document_id": "68a9fb9287746eb421572a7d",
    "document_name": "Test",
    "created_by": "686e00764347ec9cdcd9d8fe",
    "organization": "686d7644b179e714014d9025",
    "template_id": "68a9ac7b2f4a4437942ae5d8",
    "status": "complete",
    "is_expired": false,
    "expires_at": "2025-08-29T00:00:00.000Z",
    "created_at": "2025-08-23T17:34:10.459Z",
    "updated_at": "2025-08-23T17:34:46.176Z"
  }
]
}

5. Response Fields

successboolean

Indicates if the request was successful

totalItemsinteger

Total number of completed documents available

totalPagesinteger

Total number of pages for pagination

currentPageinteger

Current page number being returned

itemsonPageinteger

Number of items returned on this page

itemsarray

Array of completed document objects

Document Object Fields

document_idstring

Unique identifier for the completed document

document_namestring

Name/title of the document

created_bystring

User ID who created the document

organizationstring

Organization ID that owns the document

template_idstring

Template ID used to create this document

statusstring

Document status - will always be "complete" for this endpoint

is_expiredboolean

Whether the document has expired

expires_atstring (ISO date)

Expiration date of the document

created_atstring (ISO date)

Timestamp when the document was created

updated_atstring (ISO date)

Timestamp when the document was last updated/completed