Get Contract by External ID

Retrieves a contract using its external system identifier.

Endpoint

GET /contracts/external-id/{externalId}

Authentication

Required: Authorization header with valid token

Path Parameters

ParameterTypeRequiredDescription
externalIdstringYesExternal system identifier

Response

ContractEntity Schema

Example Usage

Get contract by external ID

curl -X GET "https://integration-api.ram.syniotec.com/master-data/v1/contract-management/contracts/externalId/EXT_CONTRACT_001" \
  -H "Authorization: Bearer YOUR_TOKEN"

Notes

  • External IDs are used to integrate with external systems or databases
  • External IDs may contain alphanumeric characters, hyphens, and underscores
  • This endpoint is useful for system integration scenarios
  • The external ID should match exactly what was used when creating the contract