Get custom field values for an entity

GET

https://app.brightmove.com/ATS/api/v1/udf/:entityTypeId/:guid

GET

/ATS/api/v1/udf/:entityTypeId/:guid

$ curl https://app.brightmove.com/ATS/api/v1/udf/5/c9d82c1c-abcd-1234-ef56-789012345678 \
>      -H "X-Brightmove-Company-ApiKey: <apiKey>" \
>      -H "Content-Type: application/json"

200Retrieved

1 [
2   {
3     "fields": [
4       {
5         "dataType": 1,
6         "fieldGk": 4821,
7         "label": "LinkedIn Profile",
8         "value": "https://linkedin.com/in/janedoe"
9       },
10       {
11         "dataType": 2,
12         "fieldGk": 4822,
13         "label": "Candidate Notes",
14         "value": "Strong communication skills and leadership experience."
15       },
16       {
17         "dataType": 3,
18         "fieldGk": 4823,
19         "label": "Willing to Relocate",
20         "value": "true"
21       },
22       {
23         "dataType": 4,
24         "fieldGk": 4824,
25         "label": "Preferred Office Location",
26         "optionGk": 301,
27         "value": "New York"
28       },
29       {
30         "dataType": 5,
31         "fieldGk": 4825,
32         "label": "Years of Experience",
33         "value": "5"
34       },
35       {
36         "dataType": 6,
37         "fieldGk": 4826,
38         "label": "Expected Salary",
39         "value": "85000"
40       },
41       {
42         "dataType": 7,
43         "fieldGk": 4827,
44         "label": "Available Start Date",
45         "value": "2024-07-01"
46       },
47       {
48         "dataType": 8,
49         "fieldGk": 4828,
50         "label": "Section Break"
51       },
52       {
53         "dataType": 9,
54         "fieldGk": 4829,
55         "label": "Recruiter Notes (Read Only)",
56         "value": "Reviewed and approved by HR."
57       },
58       {
59         "dataType": 10,
60         "fieldGk": 4830,
61         "label": "Interview Time",
62         "value": "14:30:00"
63       }
64     ],
65     "sectionGk": 88,
66     "sectionName": "Additional Details",
67     "sortOrder": 1
68   }
69 ]

Returns every custom field defined for the given entity type, grouped into sections, each populated with this specific entity’s current value — label, value (as display text), data type, and, for SELECT fields, the chosen optionGk. Fields with no value set are returned with a null value rather than omitted, so the full definition shape is always visible.

Authentication

X-Brightmove-Company-ApiKeystring

BrightMove Company Api Key

X-Brightmove-User-ApiKeystring

BrightMove User Api Key

Path parameters

entityTypeIdintegerRequired

Numeric entity type id (e.g. 5 = Requirement/Job)

guidstringRequired

GUID of the entity whose values to return

Response

Field values returned