---
title: "/codes/{codeId}"
method: GET
path: "/codes/{codeId}"
---

# /codes/{codeId}

`GET /codes/{codeId}`

## Request

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

Use this endpoint to retrieve an existing Code and its metadata

## Path parameters

- `codeId` integer, required

## Query parameters

- `$expand` string

## Response `200`

200

- union
  - object
    - `codeId` integer
    - `parentCodeId` unknown
    - `name` string
    - `description` string
    - `codeType` string
    - `dateCreated` string
    - `dateModified` string
    - `supportedEntities` unknown
  - object
    - `codeId` integer
    - `parentCodeId` integer
    - `name` string
    - `description` string
    - `codePath` string
    - `createdByName` string
    - `dateCreated` string
    - `supportedEntities` object[]
      - `name` string
      - `isSearchable` boolean
      - `isApplicable` boolean
    - `codeType` string
    - `campaign` object
      - `campaignId` integer
      - `name` string
      - `campaignType` object
        - `campaignTypeId` integer
        - `name` string
      - `campaignDisplayName` string
      - `status` string
      - `contents` unknown
    - `contactType` object
      - `contactTypeId` integer
      - `channelTypeName` string
      - `name` string
    - `dateModified` string
    - `revenueStreamId` integer
    - `generalLedgerFund` object
      - `generalLedgerFundId` integer
      - `name` string
      - `description` string
      - `isActive` boolean
    - `costCenter` object
      - `costCenterId` integer
      - `name` string
      - `description` string
      - `isActive` boolean
    - `revenueStream` object
      - `revenueStreamId` integer
      - `name` string
      - `type` object
        - `revenueStreamTypeID` integer
        - `name` string
      - `status` string
    - `mailMergeTemplate` object
      - `mailMergeTemplateId` integer
      - `name` string
    - `isSourceCodeApplicable` boolean

## Other responses

- `400`: 400
- `404`: 404

## Changes

- **2026-11-03** `4f2049fba5af`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/ngpvan/apis/van-crm/changes/codes/:codeId/get.md)

---

[API](https://skmtc.dev/ngpvan/apis/van-crm.md) - [All operations](https://skmtc.dev/ngpvan/apis/van-crm/llms.txt) - [OpenAPI document](https://skmtc.dev/ngpvan/apis/van-crm/revisions/4f2049fba5af?raw)