Get a XC document's metadata

QA Environment

https://qa-api.kiolinkapp.com

GET

/v1/xc/documents/{documentId}

XC Documents

Last modified:2026-09-25 00:34:24

Maintainer:José María Esparza Arévalo

Required Permission(s):xc-document-read

Returns a document's metadata (file name, MIME type, size, type, timestamps) by its ID, including its related XC request, connection, and DocuSign envelope (when applicable). Does not return the file itself — use the download or file endpoints for that.

Request

Authorization

API Key

Add parameter in header

authorization

Example:

authorization: ********************

Path Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://qa-api.kiolinkapp.com/v1/xc/documents/xcd_5wtWgLufm9bz2Z2x' \
--header 'authorization: <api-key>'

Responses

🟢200

application/json

The document's metadata, including its related request, connection, and DocuSign envelope.

Bodyapplication/json

Example

{
    "id": "xcd_5wtWgLufm9bz2Z2x",
    "xc_request_id": "xcr_IDdyW7BUIcvfokp4",
    "xc_connection_id": null,
    "document_type": "SOW",
    "storage_url": "uploads/event_files/xc/XC-2025-000006/SOW_1764992773752_XC-2025-000006_KIOLink_-_Portal_XC_RFC.pdf",
    "file_name": "KIOLink - Portal XC_RFC.pdf",
    "mime_type": "application/pdf",
    "file_size_bytes": 1459493,
    "uploaded_by_user_id": "6924a8df0f890e30be312081",
    "uploaded_at": "2025-12-06T03:46:14.000Z",
    "docusign_envelope_id": null,
    "xc_request": {
        "id": "xcr_IDdyW7BUIcvfokp4",
        "code": "XC-2025-000006",
        "requester_name": "JoseMa Esparev",
        "requester_email": "esparev@hotmail.com",
        "contract_term_months": 34,
        "current_status_id": "xcs_RIZDbF1tyVoMdEuX",
        "kanban_position": null,
        "priority": null,
        "is_draft": false,
        "created_by_user_id": "6924a8df0f890e30be312081",
        "assigned_xc_lead_user_id": null,
        "assigned_implementation_group_id": null,
        "external_opportunity_parent_id": null,
        "external_opportunity_parent_optional_id": null,
        "external_case_id": null,
        "external_xc_id": null,
        "sow_generated_at": null,
        "sow_signed_at": null,
        "implementation_started_at": null,
        "implementation_completed_at": null,
        "created_at": "2025-12-05T20:30:50.000Z",
        "updated_at": "2025-12-05T23:11:13.000Z"
    },
    "xc_connection": null,
    "docusign_envelope": null
}

🟠404

Modified at 2026-09-25 00:34:24

List XC documents

Get a XC document download URL