---
updatedAt: 2026-05-27T16:33:24.000Z
agentTools:
  projectIndex: https://developers.smartrecruiters.com/llms.txt
---

# Get a list of available candidate properties

Get all candidate properties and their configuration for a company.

**[ALPHA]** `MULTI_SELECT` is available to a limited set of customers under early access.


# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "version": "1.2.0",
    "title": "Configuration API",
    "contact": {
      "name": "SmartRecruiters",
      "url": "https://developers.smartrecruiters.com"
    }
  },
  "paths": {
    "/configuration/candidate-properties": {
      "get": {
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CandidatePropertyDefinitionList"
                }
              }
            }
          },
          "403": {
            "description": "Permission denied",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        },
        "description": "Get all candidate properties and their configuration for a company.\n\n**[ALPHA]** `MULTI_SELECT` is available to a limited set of customers under early access.\n",
        "tags": [
          "configuration"
        ],
        "summary": "Get a list of available candidate properties",
        "operationId": "configuration.candidate-properties.all",
        "security": [
          {
            "key": []
          },
          {
            "oauth": [
              "configuration_read"
            ]
          }
        ]
      }
    }
  },
  "components": {
    "securitySchemes": {
      "key": {
        "type": "apiKey",
        "in": "header",
        "name": "x-smarttoken"
      },
      "oauth": {
        "type": "oauth2",
        "flows": {
          "authorizationCode": {
            "authorizationUrl": "https://www.smartrecruiters.com/identity/oauth/allow",
            "tokenUrl": "https://api.smartrecruiters.com/identity/oauth/token",
            "scopes": {
              "configuration_read": "Access Company Settings",
              "configuration_manage": "Manage Company Settings",
              "company_read": "Access Company Information",
              "recruiter_sources_manage": "Manage Recruiter Sources"
            }
          }
        }
      }
    },
    "schemas": {
      "ErrorResponse": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string"
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "Error": {
        "type": "object",
        "required": [
          "code"
        ],
        "properties": {
          "code": {
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        }
      },
      "Actions": {
        "type": "object",
        "additionalProperties": {
          "$ref": "#/components/schemas/Action"
        }
      },
      "Action": {
        "type": "object",
        "required": [
          "url",
          "method"
        ],
        "properties": {
          "url": {
            "type": "string"
          },
          "method": {
            "type": "string",
            "enum": [
              "GET",
              "POST",
              "PUT",
              "PATCH",
              "OPTIONS",
              "DELETE",
              "HEAD",
              "CONNECT"
            ]
          }
        }
      },
      "CandidatePropertyType": {
        "type": "string",
        "description": "Type of a candidate property.\n\n**[ALPHA]** `MULTI_SELECT` is available to a limited set of customers under early access.\n",
        "enum": [
          "BOOLEAN",
          "COUNTRY",
          "CURRENCY",
          "DATE",
          "NUMBER",
          "PERCENT",
          "REGION",
          "TEXT",
          "USER",
          "SINGLE_SELECT",
          "MULTI_SELECT"
        ]
      },
      "CandidatePropertyDefinitionList": {
        "type": "object",
        "properties": {
          "totalFound": {
            "type": "integer"
          },
          "content": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CandidatePropertyDefinition"
            }
          }
        }
      },
      "CandidatePropertyDefinition": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "key": {
            "type": "string"
          },
          "label": {
            "type": "string"
          },
          "type": {
            "$ref": "#/components/schemas/CandidatePropertyType"
          },
          "availability": {
            "$ref": "#/components/schemas/CandidatePropertyAvailability"
          },
          "reference": {
            "$ref": "#/components/schemas/CrossSystemDataReference"
          },
          "actions": {
            "$ref": "#/components/schemas/Actions"
          }
        }
      },
      "CrossSystemDataReference": {
        "type": "object",
        "description": "Reference to an external source system. Read-only — not modifiable through SmartRecruiters.",
        "properties": {
          "type": {
            "type": "string",
            "description": "Type of the external entity (e.g. \"picklist\")."
          },
          "code": {
            "type": "string",
            "description": "Code of the external entity (e.g. \"ecPhoneType\")."
          }
        }
      },
      "CandidatePropertyAvailability": {
        "type": "object",
        "properties": {
          "toUsers": {
            "type": "string",
            "enum": [
              "ALL",
              "FULL_ACCESS"
            ]
          },
          "context": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "HIRE_FORM",
                "OFFER_FORM",
                "PROFILE",
                "OFFER_APPROVAL_FORM"
              ]
            }
          },
          "forOrgFields": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CandidatePropertyFilter"
            }
          }
        }
      },
      "CandidatePropertyFilter": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "values": {
            "$ref": "#/components/schemas/CandidatePropertyFilterValues"
          },
          "actions": {
            "$ref": "#/components/schemas/Actions"
          }
        }
      },
      "CandidatePropertyFilterValues": {
        "type": "object",
        "properties": {
          "all": {
            "type": "boolean"
          },
          "content": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://api.smartrecruiters.com"
    }
  ]
}
```