RIrillet
Contracts

Retrieves contract metadata

Changed on

Returns this contract's metadata values keyed by definition key. Keys with no value are omitted, including values held by archived definitions, which stay readable here. Definition names, types and status come from list-all-metadata-definitions.

get/contracts/{contract_id}/metadata

Request

Path parameters

contract_idstring required

UUID of the contract to retrieve metadata for.

Response

OK

metadataobject required

Values keyed by definition key. A key with no value on this record is omitted. Use list-all-metadata-definitions for definition names, types and status.

Example response

{
  "metadata": {
    "metadata.source_invoice_id": "NS-INV-004821"
  }
}

Changes