---
title: "Get candidate object references"
method: GET
path: "/candidates/{id}/object-references"
tags: ["Candidates"]
---

# Get candidate object references

`GET /candidates/{id}/object-references`

## Request

- Base URL: `https://api.cavuno.com/v1`
- URL: `https://api.cavuno.com/v1/candidates/{id}/object-references`
- Auth: HTTP bearer

## Path parameters

- `id` string, required

## Response `200`

Candidate references.

- ProfileObjectReferencesResult
  - `definitions` ProfileObjectReferenceDefinition[], required
    - `key` string, required
    - `label` string, required
    - `typeId` string, required
    - `multiple` boolean, required
    - `maxSelections` integer: Operator-set maximum number of entries a profile can select. Only meaningful when `multiple` is true; absent means the system ceiling of 100.
    - `required` boolean: Whether a profile must select at least one entry when this field is shown.
    - `visibility` 'private' | 'public', required
    - `editableByOwner` boolean, required
    - `allowOverrides` boolean, required
    - `descriptionFieldKey` string
    - `valueDefinitions` ScalarProfileCustomFieldDefinition[]
      - `key` string, required
      - `label` string, required
      - `helpText` string
      - `type` 'short_text' | 'long_text' | 'rich_text' | 'single_select' | 'multi_select' | 'boolean' | 'number' | 'date' | 'url' | 'email' | 'phone', required
      - `required` boolean, required
      - `visibility` 'private' | 'public', required
      - `editableByOwner` boolean, required
      - `options` object[]
        - `key` string, required
        - `label` string, required
      - `min` number
      - `max` number
    - `entryDefinitions` ScalarProfileCustomFieldDefinition[]
      - `key` string, required
      - `label` string, required
      - `helpText` string
      - `type` 'short_text' | 'long_text' | 'rich_text' | 'single_select' | 'multi_select' | 'boolean' | 'number' | 'date' | 'url' | 'email' | 'phone', required
      - `required` boolean, required
      - `visibility` 'private' | 'public', required
      - `editableByOwner` boolean, required
      - `options` object[]
        - `key` string, required
        - `label` string, required
      - `min` number
      - `max` number
  - `selections` ResolvedProfileObjectReference[], required
    - `fieldKey` string, required
    - `fieldLabel` string, required
    - `recordId` string, required
    - `slug` string: URL-safe identifier, unique within the collection. Changing it keeps the previous value reserved.
    - `title` string, required
    - `description` string
    - `titleOverride` string
    - `descriptionOverride` string
    - `logoUrl` string: The entry's logo: the image in the collection's logo field, or a legacy logo URL on older entries. Absent when the entry has neither.
    - `descriptionType` 'rich_text'
    - `descriptionFieldKey` string
    - `fields` object[], required
      - `key` string, required
      - `label` string, required
      - `type` 'short_text' | 'long_text' | 'rich_text' | 'single_select' | 'multi_select' | 'boolean' | 'number' | 'date' | 'url' | 'email' | 'phone' | 'image' | 'image_gallery' | 'file' | 'reference', required
      - `helpText` string
      - `options` object[]
        - `key` string, required
        - `label` string, required
    - `attributes` object, required
    - `references` object
    - `valueDefinitions` ScalarProfileCustomFieldDefinition[], required
      - `key` string, required
      - `label` string, required
      - `helpText` string
      - `type` 'short_text' | 'long_text' | 'rich_text' | 'single_select' | 'multi_select' | 'boolean' | 'number' | 'date' | 'url' | 'email' | 'phone', required
      - `required` boolean, required
      - `visibility` 'private' | 'public', required
      - `editableByOwner` boolean, required
      - `options` object[]
        - `key` string, required
        - `label` string, required
      - `min` number
      - `max` number
    - `entryDefinitions` ScalarProfileCustomFieldDefinition[], required
      - `key` string, required
      - `label` string, required
      - `helpText` string
      - `type` 'short_text' | 'long_text' | 'rich_text' | 'single_select' | 'multi_select' | 'boolean' | 'number' | 'date' | 'url' | 'email' | 'phone', required
      - `required` boolean, required
      - `visibility` 'private' | 'public', required
      - `editableByOwner` boolean, required
      - `options` object[]
        - `key` string, required
        - `label` string, required
      - `min` number
      - `max` number
    - `values` object, required
    - `entries` object[], required
      - `key` string, required
      - `values` object, required

## Other responses

- `default`: An error. Every non-2xx response uses the same envelope; see the Errors section of the introduction.

## Changes

- **2026-10-19** `c34152c38176`: 1 info
  - added the optional property `error/upgrade` to the response with the `default` status

[Operation history](https://skmtc.dev/cavuno/apis/cavuno-v1-rest-api/changes/candidates/:id/object-references/get.md)

---

[API](https://skmtc.dev/cavuno/apis/cavuno-v1-rest-api.md) · [All operations](https://skmtc.dev/cavuno/apis/cavuno-v1-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/cavuno/apis/cavuno-v1-rest-api/revisions/d5974dabff14?raw)