Skip to main content

List Artifacts

List all artifacts you’ve uploaded.

Endpoint

GET /ramp/artifacts

Query Parameters

ParameterTypeRequiredDescription
statusstringNoFilter by status: active, revoked
template_idstringNoFilter by template
pageintegerNoPage number (default: 1)
limitintegerNoItems per page (default: 50, max: 100)

Request

curl -X GET "https://api.docyard.io/v1/ramp/artifacts?status=active&limit=20" \
  -H "X-API-Key: dk_live_dist_aaaaaaaa"

Response

{
  "artifacts": [
    {
      "id": "art-abc123",
      "template_name": "Insurance Declaration Page",
      "status": "active",
      "locks": {
        "policy_number": "POL-12345678",
        "effective_date": "2026-03-15"
      },
      "threshold": 20,
      "created_at": "2026-03-15T10:30:00Z",
      "retrieval_count": 5
    },
    {
      "id": "art-def456",
      "template_name": "Insurance Declaration Page",
      "status": "revoked",
      "locks": {
        "policy_number": "POL-87654321",
        "effective_date": "2026-03-14"
      },
      "threshold": 20,
      "created_at": "2026-03-14T09:00:00Z",
      "revoked_at": "2026-03-15T15:00:00Z",
      "retrieval_count": 12
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 1542,
    "total_pages": 78
  }
}