NGngpvan

/codes/{codeId}

Changed on

Use this endpoint to retrieve an existing Code and its metadata

get/codes/{codeId}

Request

  • Base URL
    https://api.securevan.com/v4
  • URL
    https://api.securevan.com/v4/codes/{codeId}
  • Auth
    HTTP basic

Path parameters

codeIdinteger required

Required; Unique identifier of an existing Code

Query parameters

$expandstring

Valid $expand sections differ by codeType. supportedEntities is valid for all types. The following are only valid for SourceCode: generalLedgerFund, costCenter, revenueStream, directResponsePlan, and mailMergeTemplate.

Response

200

OR

Example response

{
  "codeId": 20548,
  "name": "Digital ads",
  "description": "Used to mark people and contributions retrieved because of digital ad campaigns",
  "codeType": "SourceCode",
  "dateCreated": "2017-10-05T12:59:00Z",
  "dateModified": "2017-10-08T12:00:00Z"
}

Changes