Get job custom field definitions
curl --request GET \
--url https://api.stardex.ai/v1/custom-fields/jobs \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.stardex.ai/v1/custom-fields/jobs"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.stardex.ai/v1/custom-fields/jobs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.stardex.ai/v1/custom-fields/jobs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.stardex.ai/v1/custom-fields/jobs"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.stardex.ai/v1/custom-fields/jobs")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stardex.ai/v1/custom-fields/jobs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": [
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "Seniority Level",
"description": "Candidate seniority classification",
"data_type": "single-select",
"job_id": null,
"list_id": null,
"tags": [
{
"id": "f1e2d3c4-b5a6-7890-abcd-ef1234567890",
"name": "Junior",
"color": "#86efac",
"description": null
},
{
"id": "f2e3d4c5-b6a7-8901-bcde-f12345678901",
"name": "Mid",
"color": "#93c5fd",
"description": null
},
{
"id": "f3e4d5c6-b7a8-9012-cdef-g12345678902",
"name": "Senior",
"color": "#d8b4fe",
"description": null
}
]
},
{
"id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"name": "Tags",
"description": "General-purpose tags for categorization",
"data_type": "multi-select",
"job_id": null,
"list_id": null,
"tags": [
{
"id": "a1b2c3d4-1234-5678-9abc-def012345678",
"name": "Banking",
"color": "#fde68a",
"description": null
},
{
"id": "a2b3c4d5-2345-6789-0abc-def123456789",
"name": "Fintech",
"color": "#a5f3fc",
"description": null
},
{
"id": "a3b4c5d6-3456-7890-1abc-def234567890",
"name": "Referred",
"color": "#fca5a5",
"description": null
}
]
},
{
"id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
"name": "Years of Experience",
"description": "Total years of professional experience",
"data_type": "integer",
"job_id": null,
"list_id": null,
"tags": []
},
{
"id": "d4e5f6a7-b8c9-0123-defa-234567890123",
"name": "Available From",
"description": "Earliest start date",
"data_type": "date",
"job_id": null,
"list_id": null,
"tags": []
}
]
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}Custom Fields
Get job custom field definitions
Retrieve custom attribute definitions for jobs, including available tag options.
When to use: Call this to discover job-level attribute IDs needed when including custom_fields in job list/detail endpoints or sorting by custom_<attribute_id> in search results.
GET
/
v1
/
custom-fields
/
jobs
Get job custom field definitions
curl --request GET \
--url https://api.stardex.ai/v1/custom-fields/jobs \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.stardex.ai/v1/custom-fields/jobs"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.stardex.ai/v1/custom-fields/jobs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.stardex.ai/v1/custom-fields/jobs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.stardex.ai/v1/custom-fields/jobs"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.stardex.ai/v1/custom-fields/jobs")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stardex.ai/v1/custom-fields/jobs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": [
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "Seniority Level",
"description": "Candidate seniority classification",
"data_type": "single-select",
"job_id": null,
"list_id": null,
"tags": [
{
"id": "f1e2d3c4-b5a6-7890-abcd-ef1234567890",
"name": "Junior",
"color": "#86efac",
"description": null
},
{
"id": "f2e3d4c5-b6a7-8901-bcde-f12345678901",
"name": "Mid",
"color": "#93c5fd",
"description": null
},
{
"id": "f3e4d5c6-b7a8-9012-cdef-g12345678902",
"name": "Senior",
"color": "#d8b4fe",
"description": null
}
]
},
{
"id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"name": "Tags",
"description": "General-purpose tags for categorization",
"data_type": "multi-select",
"job_id": null,
"list_id": null,
"tags": [
{
"id": "a1b2c3d4-1234-5678-9abc-def012345678",
"name": "Banking",
"color": "#fde68a",
"description": null
},
{
"id": "a2b3c4d5-2345-6789-0abc-def123456789",
"name": "Fintech",
"color": "#a5f3fc",
"description": null
},
{
"id": "a3b4c5d6-3456-7890-1abc-def234567890",
"name": "Referred",
"color": "#fca5a5",
"description": null
}
]
},
{
"id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
"name": "Years of Experience",
"description": "Total years of professional experience",
"data_type": "integer",
"job_id": null,
"list_id": null,
"tags": []
},
{
"id": "d4e5f6a7-b8c9-0123-defa-234567890123",
"name": "Available From",
"description": "Earliest start date",
"data_type": "date",
"job_id": null,
"list_id": null,
"tags": []
}
]
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}Was this page helpful?
⌘I