Skip to main content

Get Document Configuration

Method: GET
/api/v1/document-configurations/{id}

Description​

This endpoint retrieves a specific document configuration by its unique ID. Document configurations typically store settings or templates related to documents in the Trace system.

🔑 Authentication​

This endpoint requires authentication via headers.

ParamValueType
tenantId{{tenantId}}string

Path Parameters​

NameTypeDescription
idstringThe unique ID of the document configuration to retrieve.

Response: 200 OK​

A successful response returns the requested document configuration details.

Example Response:

{
  "id": "12345",
  "name": "Invoice Configuration",
  "description": "Configuration for invoice templates",
  "createdAt": "2025-02-12T10:00:00Z",
  "updatedAt": "2025-02-13T12:00:00Z",
  "tenantId": "tenant123"
}

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST

curl --request GET \ 
 --url  /api/v1/document-configurations/{id} \ 
 --header 'accept: application/json' \ 
 --header 'content-type: application/json'

RESPONSE

Click Try It! to start a request and see the response here!