KIO Link
KIO Link XC API
KIO Link APIKIO BMSHuawei BMSHuawei Alert
KIO Link XC API
KIO Link APIKIO BMSHuawei BMSHuawei Alert
  1. XC Requests
  • DocuSign
    • Overview
    • List a XC request's DocuSign envelopes
      GET
    • Get an embeded URL signature for a XC Request
      GET
    • Regenerate a URL signature for the current signer
      GET
    • List the order of signers of a DocuSign Envelope
      GET
    • Create a DocuSign envelope for a XC request
      POST
    • Resend email & recover URL signature for a XC request
      POST
    • Create a DocuSign envelope for multiple signers
      POST
  • XC Client Prices
    • Overview
    • List XC client prices
      GET
    • Get a XC client's price
      GET
    • Create a XC client's price
      POST
    • Update a XC client's price
      PATCH
    • Delete a XC client's price
      DELETE
  • XC Comments
    • Overview
    • List XC comments
      GET
    • Get a XC comment
      GET
    • Create a XC comment
      POST
    • Update a XC comment
      PATCH
    • Delete a XC comment
      DELETE
  • XC Connections
    • Overview
    • List XC connections
    • Get a XC connection
    • Create a XC connection
    • Update a XC connection
    • Delete a XC connection
  • XC Contract Settings
    • Overview
    • List XC contract settings
    • Get a XC contract setting
    • Get a XC Request's contract setting
    • Create a XC contract setting
    • Update a XC contract setting
    • Delete a XC contract setting
  • XC Contract Setting Participants
    • Overview
    • List all XC contract settings participants
    • List a XC contract settings participants
    • Get a XC contract settings participant
    • Create a XC contract settings participant
    • Update a XC contract settings participant
    • Delete a XC contract settings participant
  • XC Data Centers
    • Overview
    • List XC datacenters
    • Create a XC datacenter
    • Update a XC datacenter
    • Delete a XC datacenter
  • XC Documents
    • Overview
    • List XC documents
    • Get a XC document's metadata
    • Get a XC document download URL
    • Get a XC document binary file
    • Upload a XC document
    • Delete a XC document
  • XC Reports
    • Overview
    • Download XC requests report
    • Download XC satisfaction survey report
    • Download XC connections report
  • XC Requests
    • Overview
    • List XC requests
      GET
    • Get a XC request
      GET
    • Get a XC request (complete details)
      GET
    • Create a XC request
      POST
    • Upsert a XC request draft
      PUT
    • Update a XC request's general data
      PATCH
    • Change a XC request's status
      PATCH
    • Delete a XC request
      DELETE
    • Revert a XC request to Revision
      PATCH
  • XC Salesforce
    • Overview
    • Accounts
      • Overview
      • List accounts
      • Get an account
    • Opportunities
      • Overview
      • Attachments
        • Overview
        • List opportunity attachments
        • Upload an opportunity attachment
        • Download an opportunity file
      • List opportunities
      • Get an opportunity
      • Create an opportunity
      • Update an opportunity
    • Products
      • Overview
      • List products
      • Get a product
    • Project Requests
      • Overview
      • List project requests
      • Get a project request
      • Create a project request
      • Update a project request
    • Users
      • Overview
      • List users
      • Get a user
    • XC/IC Requests
      • Overview
      • Attachments
        • Overview
        • List XC/IC attachments
        • Upload a XC/IC attachment
        • Download a XC/IC file
      • List XC/IC requests
      • List all KIO Link connections from Salesforce XC/IC requests
      • Get a XC/IC request
      • Create a XC/IC request
      • Update a XC/IC request
  • XC Satisfaction Survey
    • Overview
    • List XC satisfaction surveys
    • Get a XC satisfaction survey
    • Get a XC satisfaction survey per user
    • Create XC satisfaction survey
  • XC Statuses
    • Overview
    • List XC statuses
    • Get a XC status
    • Create a XC status
    • Update a XC status
    • Delete a XC status
  • XC Status Histories
    • Overview
    • List XC status histories
    • List XC status history time summary
    • Get a XC status history record
  • Schemas
    • DocuSign
      • DocuSign Envelope Signer
      • DocuSign Signing URL Result
      • DocuSign Signer Routing
      • DocuSign Resend Result
      • DocuSign Envelope
    • XC Client Prices
      • XC Client Price
    • XC Comments
      • XC Comment
    • XC Connections
      • XC Connection
    • XC Contract Settings
      • XC Contract Setting
    • XC Contract Setting Participants
      • XC Contract Setting Participant
    • XC Data Centers
      • XC Datacenter
    • XC Documents
      • XC Document
    • XC Requests
      • XC Request With Relations
      • XC Request List Item
      • XC Request
      • XC Request With Details
    • XC Salesforce
      • Salesforce Connection
      • Salesforce Account
      • Salesforce User
      • Salesforce Product
      • Salesforce Opportunity List Item
      • Salesforce Opportunity
      • Salesforce Opportunity Write Result
      • Salesforce Attachment
      • Salesforce Attachment Upload Result
      • Salesforce Attachment Download Result
      • Salesforce Request List Item
      • Salesforce Request Point
      • Salesforce Request
      • Salesforce Request Write Result
      • Salesforce Project Request
      • Salesforce Project Request Write Result
      • Salesforce Quote
      • Salesforce Quote Line
    • XC Satisfaction Surveys
      • XC Satisfaction Survey
    • XC Statuses
      • XC Status
    • XC Status Histories
      • XC Status Time
      • XC Status Stage Time
      • XC Status History
    • Error
    • Date Metadata
    • Pagination Metadata
  1. XC Requests

Get a XC request

QA Environment
https://qa-api.kiolinkapp.com
QA Environment
https://qa-api.kiolinkapp.com
GET
https://qa-api.kiolinkapp.com
/v1/xc/requests/{id}
XC Requests
Last modified:2026-09-25 00:46:29
Maintainer:José María Esparza Arévalo
Required Permission(s):xc-request-read
Returns a single XC request's core record by its ID, including its current status and contract setting (with client price and participants). Does not include connections, documents, or status history — use the "complete details" endpoint for those.

Request

Authorization
API Key
Add parameter in header
authorization
Example:
authorization: ********************
or
Path Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://qa-api.kiolinkapp.com/v1/xc/requests/xcr_QHjd8L4wLCoP2Mlg' \
--header 'authorization: <api-key>'

Responses

🟢200
application/json
The request, including its current status and contract setting.
Bodyapplication/json

Example
{
    "id": "xcr_BpnCIvoscr3ULQs9",
    "type": "XC",
    "code": "XC-2025-000005",
    "requester_name": "John Wick",
    "requester_email": "john_wick@gmail.com",
    "contract_term_months": 26,
    "current_status_id": "xcs_uKwYYmF2N9p2fmQW",
    "kanban_position": null,
    "priority": null,
    "is_draft": false,
    "created_by_user_id": "6924a8df0f890e30be312081",
    "business_id": null,
    "assigned_xc_lead_user_id": null,
    "assigned_implementation_group_id": null,
    "external_opportunity_parent_id": null,
    "external_opportunity_parent_optional_id": null,
    "external_opportunity_parent_number": null,
    "external_opportunity_parent_optional_number": 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-05T07:35:07.000Z",
    "updated_at": "2025-12-05T07:35:07.000Z",
    "current_status": {
        "id": "xcs_uKwYYmF2N9p2fmQW",
        "code": "RECIBIDO",
        "name": "Recibido",
        "description": "Se ha recibido la solicitud XC",
        "order_index": null,
        "category": null,
        "salesforce_stage_code": null
    },
    "contract_setting": {
        "id": "xccs_lhBjxisjcWeNMafI",
        "doc_lang": "EN",
        "nrc_price": "500.00",
        "mrc_price": "375.00",
        "currency": "USD",
        "account_name": "XC Estándar (Test)",
        "xc_client_price_id": "xccp_TEpLV0SOyIrZ4k5j",
        "xc_request_id": "xcr_BpnCIvoscr3ULQs9",
        "participants": [
            {
                "id": "xccsp_NqcdtJFP3PerDjQ8",
                "name": "Flora Feil",
                "email": "Ashlee62@yahoo.com",
                "role": null,
                "company_name": "Herman - Casper",
                "business_name": "Russel Inc",
                "contract_setting_id": "xccs_lhBjxisjcWeNMafI",
                "created_at": "2026-03-20T20:17:11.000Z",
                "updated_at": "2026-03-20T20:17:11.000Z"
            }
        ],
        "created_at": "2026-03-20T19:51:14.000Z",
        "updated_at": "2026-03-20T20:04:24.000Z"
    }
}
🟠404
Modified at 2026-09-25 00:46:29
Previous
List XC requests
Next
Get a XC request (complete details)
Built with