Get a Job by GUID

GET

https://app.brightmove.com/ATS/api/v1/requirements/:guid

GET

/ATS/api/v1/requirements/:guid

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

200Retrieved

1 {
2   "approvalStatus": "Approved",
3   "bonusFlat": 1000,
4   "bonusNotes": "Paid after 90 days.",
5   "bonusPct": 10,
6   "categories": [
7     {
8       "id": 12,
9       "name": "Information Technology"
10     }
11   ],
12   "client": {
13     "guid": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
14     "name": "Acme Corporation"
15   },
16   "clientContact": {
17     "guid": "c3d4e5f6-a7b8-9012-cdef-123456789012",
18     "name": "Chris Ariotti"
19   },
20   "clientOffice": {
21     "guid": "d085cae4-ee67-4149-af1b-e8366c0061bc",
22     "name": "Nashville Office"
23   },
24   "createDate": "2026-01-20T14:14:52Z",
25   "duration": "6 months",
26   "endDate": "2026-07-20T00:00:00Z",
27   "feeAmt": 15000,
28   "feePct": 20,
29   "functions": [
30     {
31       "id": 7,
32       "name": "Engineering"
33     }
34   ],
35   "guid": "c9d82c1c-abcd-1234-ef56-789012345678",
36   "industries": [
37     {
38       "id": 5,
39       "name": "Software Development"
40     }
41   ],
42   "jobGroupName": "Engineering",
43   "jobTitle": "Senior Java Engineer",
44   "location": "Tampa, FL (Hybrid)",
45   "locationAddress": "100 N Ashley Dr",
46   "locationCity": "Tampa",
47   "locationPostalCode": "33602",
48   "locationState": "Florida",
49   "maxBillTypeId": 1,
50   "maxPayTypeId": 1,
51   "minBillTypeId": 1,
52   "minPayTypeId": 1,
53   "modifyDate": "2026-01-20T14:14:57Z",
54   "openings": 2,
55   "originalOpenings": 2,
56   "partTime": false,
57   "percentChanceClose": 65,
58   "placementTypeId": 2,
59   "postToInternal": true,
60   "postToWeb": false,
61   "privateDescription": "Client prefers local candidates. Budget is flexible.",
62   "publicDescription": "We are looking for an experienced Java engineer to join our dynamic team and help build scalable applications.",
63   "recruiters": [
64     {
65       "guid": "f1e2d3c4-b5a6-7890-cdef-123456789abc",
66       "name": "Michael Johnson"
67     }
68   ],
69   "reqNumber": "REQ-1042",
70   "requirementLocations": [
71     {
72       "city": "Austin",
73       "id": 10432,
74       "postalCode": "78701",
75       "state": "Texas",
76       "stateAbbr": "TX"
77     }
78   ],
79   "salesRep": {
80     "guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
81     "name": "Jane Smith"
82   },
83   "sourcers": [
84     {
85       "guid": "a9b8c7d6-e5f4-3210-abcd-9876543210fe",
86       "name": "Emily Davis"
87     }
88   ],
89   "status": "Open",
90   "statusComment": "Client paused search pending budget approval.",
91   "vendors": [
92     {
93       "guid": "5c6d7e8f-9012-3456-abcd-ef0123456789",
94       "name": "Acme Staffing Partners"
95     }
96   ],
97   "workFromHome": false,
98   "workHybrid": true,
99   "workRemote": false,
100   "workStateWide": false,
101   "workgroups": [
102     {
103       "id": 3,
104       "name": "Product Development"
105     }
106   ]
107 }

Returns the full detail of a single Job, including:

Core fields
Compensation and rate types
Placement type and job group
Assigned recruiters, sourcers, and vendors
Categorization (categories, industries, functions, workgroups)
Additional marketing locations
Work-arrangement flags

Returns the full detail of a single Job, including: - Core fields - Compensation and rate types - Placement type and job group - Assigned recruiters, sourcers, and vendors - Categorization (categories, industries, functions, workgroups) - Additional marketing locations - Work-arrangement flags

Authentication

X-Brightmove-Company-ApiKeystring

BrightMove Company Api Key

X-Brightmove-User-ApiKeystring

BrightMove User Api Key

Path parameters

guidstringRequired

Stable public identifier of the requirement

Response

Requirement found and returned