-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathopenapi.yaml
More file actions
2138 lines (2058 loc) · 68.7 KB
/
openapi.yaml
File metadata and controls
2138 lines (2058 loc) · 68.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.1.0
info:
title: EURES Job Search API
version: 1.0.0
description: |
Reverse-engineered documentation of the EURES (European Employment Services) Job Search API,
as exposed by the EURES portal at https://europa.eu/eures.
This specification is based on observed API calls and responses from the public EURES portal.
It is not an official API specification. Endpoints, schemas, and enum values reflect what has
been confirmed through direct HTTP interaction with the live API.
Usage of this API is subject to the EURES portal terms of use:
https://europa.eu/eures/portal/jv-se/home?lang=en&pageCode=find_a_job#openDisclaimerQualityDialog
Neither the maintainers of this documentation project nor the EURES portal accept liability
for damages or losses arising from use of this API or its documentation.
contact:
name: EURES API Documentation
url: https://github.com/rorar/EURES-API-Documentation/issues
license:
name: MIT
url: https://opensource.org/licenses/MIT
externalDocs:
description: EURES API Documentation repository on GitHub
url: https://github.com/rorar/EURES-API-Documentation
servers:
- url: https://europa.eu/eures/api
description: EURES production API
security: []
tags:
- name: Job Search
description: Job vacancy search and retrieval endpoints
- name: Reference Data
description: Reference data endpoints for languages, countries, and classification codes
- name: Statistics
description: Job vacancy statistics and aggregation endpoints
- name: Autocomplete
description: Type-ahead suggestion endpoints for occupation search
- name: Vacancy Detail
description: Individual job vacancy retrieval
- name: ESCO
description: European Skills, Competences, Qualifications and Occupations classification data
- name: User
description: User profile and authentication state
- name: Configuration
description: Portal and search engine configuration
- name: Translation
description: Machine translation availability and configuration
- name: Menu
description: Portal navigation menu structure
paths:
/jv-searchengine/public/jv-search/search:
post:
operationId: searchJobVacancies
summary: Search job vacancies
description: |
Searches the EURES job vacancy database using a combination of keyword, location,
occupation, skill, and filter criteria. Supports pagination and returns both matched
vacancies and aggregated facet counts.
All filter arrays accept empty arrays to indicate no filter is applied. The
`requestLanguage` field controls the language of returned text fields.
tags:
- Job Search
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/JobSearchRequest'
examples:
keywordSearch:
summary: Basic keyword search
value:
resultsPerPage: 10
page: 1
sortSearch: BEST_MATCH
keywords:
- keyword: software engineer
specificSearchCode: EVERYWHERE
publicationPeriod: null
occupationUris: []
skillUris: []
requiredExperienceCodes: []
positionScheduleCodes: []
sectorCodes: []
educationAndQualificationLevelCodes: []
positionOfferingCodes: []
locationCodes: []
euresFlagCodes: []
otherBenefitsCodes: []
requiredLanguages: []
minNumberPost: null
sessionId: session-abc123
userPreferredLanguage: null
requestLanguage: en
filteredSearch:
summary: Search with location and experience filters
value:
resultsPerPage: 25
page: 1
sortSearch: MOST_RECENT
keywords:
- keyword: nurse
specificSearchCode: EVERYWHERE
publicationPeriod: LAST_WEEK
occupationUris: []
skillUris: []
requiredExperienceCodes:
- between_2_and_5_years
- more_than_5_years
positionScheduleCodes:
- fulltime
sectorCodes:
- q
educationAndQualificationLevelCodes:
- bachelor
positionOfferingCodes:
- directhire
- contract
locationCodes:
- de
- at
euresFlagCodes:
- WITH
otherBenefitsCodes: []
requiredLanguages:
- de(C2)
- en(B1)
minNumberPost: null
sessionId: session-xyz789
userPreferredLanguage: de
requestLanguage: de
responses:
'200':
description: Successful job vacancy search response
content:
application/json:
schema:
$ref: '#/components/schemas/JobSearchResponse'
examples:
searchResult:
summary: Example search result
value:
numberRecords: 1787657
jvs:
- title: Software Engineer
description: <p>HTML description...</p>
id: MTAwMDEtMTAwMTEzOTMxMS1TIDE
creationDate: 1739403609768
lastModificationDate: 1768605849756
numberOfPosts: 1
locationMap:
DE:
- DE12B
euresFlag: false
jobCategoriesCodes:
- http://data.europa.eu/esco/occupation/f2b15a0e-e65a-438a-affb-29b9d50b77d1
- http://data.europa.eu/esco/isco/C5243
positionScheduleCodes:
- fulltime
positionOfferingCode: directhire
employer:
name: SUSS MicroTec Solutions GmbH & Co. KG
legalID: null
organisationSizeCode: null
organisationOwnershipTypeCode: null
website: www.suss.com
sectorCodes: []
description: null
availableLanguages:
- de
score: null
translationType: FIRST_LANGUAGE
translations:
de:
title: Software Engineer Safety (m/w/d)
description: <p>...</p>
facets:
LANGUAGE_SKILLS:
facetEntriesList:
- code: en
count: 68096
childrenList: []
POSITION_SCHEDULE:
facetEntriesList:
- code: fulltime
count: 1102456
childrenList: []
/shared-data-rest-api/public/reference/languages:
get:
operationId: getReferenceLanguages
summary: Get supported languages
description: |
Returns the list of all languages supported by the EURES portal. Each entry contains
the internal numeric ID, the ISO 639-1 language code, and the language name in its
native script. Returns 26 languages total.
tags:
- Reference Data
responses:
'200':
description: List of supported languages
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Language'
examples:
languages:
summary: Sample language list
value:
- id: 1
isoCode: bg
label: "български"
- id: 6
isoCode: en
label: English
- id: 7
isoCode: de
label: Deutsch
/shared-data-rest-api/public/reference/countries:
get:
operationId: getReferenceCountries
summary: Get supported countries
description: |
Returns the list of ISO 3166-1 alpha-2 country codes for all countries covered by
EURES. Includes EU member states plus EFTA countries (Iceland, Liechtenstein,
Norway, Switzerland). Returns 31 country codes total.
tags:
- Reference Data
responses:
'200':
description: List of country codes (ISO 3166-1 alpha-2)
content:
application/json:
schema:
type: array
items:
type: string
description: ISO 3166-1 alpha-2 country code
pattern: "^[A-Z]{2}$"
examples:
countries:
summary: All covered countries
value:
- AT
- BE
- BG
- HR
- CY
- CZ
- DK
- EE
- FI
- FR
- DE
- EL
- HU
- IS
- IE
- IT
- LV
- LI
- LT
- LU
- MT
- NL
- NO
- PL
- PT
- RO
- SK
- SI
- ES
- SE
- CH
/shared-data-rest-api/public/reference/nace:
get:
operationId: getReferenceNace
summary: Get NACE sector classifications
description: |
Returns the list of NACE (Nomenclature of Economic Activities) sector classification
codes used by EURES. Returns 21 entries at level 1 (top-level divisions), using
NACE Revision 2.0. The `code` field corresponds to the uppercase letter codes used
in job search requests as lowercase values in `sectorCodes`.
tags:
- Reference Data
responses:
'200':
description: List of NACE classification entries
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/NaceEntry'
examples:
naceEntries:
summary: Sample NACE entries
value:
- id: 1
code: A
level: 1
revision: "2.0"
- id: 57
code: B
level: 1
revision: "2.0"
/jv-searchengine/public/jv/id/{id}:
get:
operationId: getJobVacancyById
summary: Get job vacancy detail
description: |
Retrieves the full detail of a single job vacancy by its base64-encoded identifier.
Returns all language profiles, employer details, location data, application
instructions, and translation metadata.
tags:
- Vacancy Detail
parameters:
- name: id
in: path
required: true
schema:
type: string
description: Base64-encoded vacancy identifier from search results.
example: MTAwMDEtMTAwMTEzOTMxMS1TIDE
- name: requestLang
in: query
required: false
schema:
type: string
description: ISO 639-1 language code for the response content.
example: de
- name: preferredLang
in: query
required: false
schema:
type:
- string
- "null"
description: User's preferred language code, or null.
example: null
responses:
'200':
description: Full vacancy detail
content:
application/json:
schema:
$ref: '#/components/schemas/JobVacancyDetail'
/jv-searchengine/public/statistics/getNumberOfJobs:
get:
operationId: getNumberOfJobs
summary: Get total job count
description: Returns the total number of active job vacancies in the EURES portal.
tags:
- Statistics
responses:
'200':
description: Total job count
content:
application/json:
schema:
$ref: '#/components/schemas/JobCountResponse'
/jv-searchengine/public/statistics/getCountryStats:
get:
operationId: getCountryStats
summary: Get job statistics by country
description: |
Returns hierarchical statistics of job vacancies grouped by country and NUTS
sub-regions. Each country entry contains nested region entries in `children`.
Includes an `NS` (not specified) entry for vacancies without a classified country.
tags:
- Statistics
responses:
'200':
description: Country-level job statistics
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CountryStatEntry'
/jv-searchengine/public/statistics/getSectorStats:
get:
operationId: getSectorStats
summary: Get job statistics by NACE sector
description: |
Returns job vacancy counts grouped by NACE economic sector codes.
Includes an `NS` (not specified) entry for vacancies without a classified sector.
tags:
- Statistics
responses:
'200':
description: Sector-level job statistics
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SectorStatEntry'
/jv-searchengine/public/statistics/getOccupationStats:
get:
operationId: getOccupationStats
summary: Get job statistics by occupation
description: Returns top ESCO occupation categories ranked by vacancy count.
tags:
- Statistics
responses:
'200':
description: Occupation-level job statistics
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/OccupationStatEntry'
/jv-searchengine/public/properties:
get:
operationId: getSearchEngineProperties
summary: Get search engine configuration
description: Returns search engine configuration key-value pairs.
tags:
- Configuration
responses:
'200':
description: Configuration properties
content:
application/json:
schema:
type: object
additionalProperties:
type: string
/jv-searchengine/public/translation/enabled:
get:
operationId: getTranslationEnabled
summary: Check if translation is enabled
description: Returns whether machine translation is enabled for the search engine.
tags:
- Translation
responses:
'200':
description: Translation enabled status
content:
application/json:
schema:
type: boolean
/jv-searchengine/public/translation/languages:
get:
operationId: getTranslationLanguages
summary: Get translation language codes
description: |
Returns the list of language codes supported for machine translation. The list
uses BCP 47 / IETF language tags, which include ISO 639-1 two-letter codes
(e.g. `de`, `fr`), ISO 639-3 three-letter codes (e.g. `fil`, `yue`), locale
variants (e.g. `fr-CA`, `pt-PT`), script variants (e.g. `zh-Hans`, `sr-Cyrl`),
and two special entries: `transliteration` and `dictionary`.
This endpoint returns the Azure Translator supported language list. Note that
translation is currently disabled (`/translation/enabled` returns `false`).
tags:
- Translation
responses:
'200':
description: List of translation language codes (BCP 47 tags)
content:
application/json:
schema:
type: array
items:
type: string
description: |
BCP 47 language tag, or one of the special values `transliteration`
and `dictionary`.
/autocomplete-repository-rest-api/public/v2.0/occupations:
get:
operationId: autocompleteOccupations
summary: Autocomplete occupation names
description: |
Returns type-ahead occupation name suggestions based on a keyword prefix.
Results are ranked by vacancy frequency (most common first).
**Rate limiting:** This endpoint enforces stricter rate limits than other EURES
endpoints. Exceeding the limit returns `401 Unauthorized` with a
`WWW-Authenticate: Bearer` header (despite not being an authentication issue).
The cooldown period is approximately 60 seconds. Callers making rapid successive
requests should implement backoff logic.
tags:
- Autocomplete
parameters:
- name: language
in: query
required: true
schema:
type: string
description: ISO 639-1 language code for suggestions.
example: de
- name: keyword
in: query
required: true
schema:
type: string
description: Search prefix for occupation names.
example: Software
- name: nbResults
in: query
required: false
schema:
type: integer
default: 10
description: Maximum number of suggestions to return.
example: 10
responses:
'200':
description: Occupation autocomplete suggestions
content:
application/json:
schema:
$ref: '#/components/schemas/OccupationAutocompleteResponse'
'401':
description: |
Rate limit exceeded. Returns an empty body with `WWW-Authenticate: Bearer`
header. This is not an authentication error — retry after ~60 seconds.
/shared-data-rest-api/public/reference/isoLanguages:
get:
operationId: getIsoLanguages
summary: Get all ISO 639-1 languages
description: |
Returns the complete list of ISO 639-1 languages with an `euresSupported` flag
indicating which languages are fully supported by the EURES portal (26 supported,
185 total).
tags:
- Reference Data
responses:
'200':
description: Full ISO language list
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/IsoLanguage'
/shared-data-rest-api/public/esco/supportedLanguages:
get:
operationId: getEscoSupportedLanguages
summary: Get ESCO supported language codes
description: Returns ISO 639-1 codes of languages supported by the ESCO classification system.
tags:
- ESCO
responses:
'200':
description: List of ESCO-supported language codes
content:
application/json:
schema:
type: array
items:
type: string
/shared-data-rest-api/public/esco/label/{lang}:
post:
operationId: getEscoLabels
summary: Resolve ESCO URIs to labels
description: |
Accepts a list of ESCO URIs (occupations, skills, ISCO codes) and returns their
human-readable labels in the specified language.
tags:
- ESCO
parameters:
- name: lang
in: path
required: true
schema:
type: string
description: ISO 639-1 language code for returned labels.
example: de
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
type: string
format: uri
example:
- "http://data.europa.eu/esco/isco/C2511"
- "http://data.europa.eu/esco/occupation/f2b15a0e-e65a-438a-affb-29b9d50b77d1"
responses:
'200':
description: Map of ESCO URIs to labels
content:
application/json:
schema:
type: object
additionalProperties:
type: string
/shared-data-rest-api/public/esco/occupation/tree:
get:
operationId: getEscoOccupationTree
summary: Get ESCO occupation hierarchy
description: |
Returns the full hierarchical tree of ESCO/ISCO occupation classifications.
Top-level nodes are ISCO major groups (C0-C9), with nested ISCO sub-groups
and individual ESCO occupation URIs as leaf nodes.
tags:
- ESCO
responses:
'200':
description: Hierarchical occupation tree
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/OccupationTreeNode'
/public/security/profile:
get:
operationId: getUserProfile
summary: Get current user profile
description: |
Returns the profile of the currently authenticated user. All personal fields
are null for unauthenticated (anonymous) requests.
tags:
- User
responses:
'200':
description: User profile
content:
application/json:
schema:
$ref: '#/components/schemas/UserProfile'
/shared-data-rest-api/public/properties/public:
get:
operationId: getPublicProperties
summary: Get portal configuration
description: Returns public portal configuration as key-value pairs.
tags:
- Configuration
responses:
'200':
description: Portal configuration properties
content:
application/json:
schema:
type: object
additionalProperties:
type: string
/shared-data-rest-api/public/menu/{section}:
get:
operationId: getMenuEntries
summary: Get portal menu entries
description: Returns navigation menu entries for a portal section.
tags:
- Menu
parameters:
- name: section
in: path
required: true
schema:
type: string
enum:
- JOBSEEKERS
- EMPLOYERS
- LIVING
- ABOUT
- CONTACT_EURES_HELPDESK
- MYEURES
description: Portal section identifier.
example: JOBSEEKERS
responses:
'200':
description: List of menu entries
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/MenuEntry'
components:
schemas:
# -------------------------------------------------------------------------
# Request schemas
# -------------------------------------------------------------------------
JobSearchRequest:
type: object
required:
- resultsPerPage
- page
- sortSearch
- keywords
- occupationUris
- skillUris
- requiredExperienceCodes
- positionScheduleCodes
- sectorCodes
- educationAndQualificationLevelCodes
- positionOfferingCodes
- locationCodes
- euresFlagCodes
- otherBenefitsCodes
- requiredLanguages
- sessionId
- requestLanguage
properties:
resultsPerPage:
type: integer
minimum: 1
maximum: 50
description: Number of job vacancies to return per page.
example: 10
page:
type: integer
minimum: 1
description: 1-based page index for pagination.
example: 1
sortSearch:
$ref: '#/components/schemas/SortOrder'
keywords:
type: array
description: |
List of keyword search terms. An empty array performs an unfiltered search
across all vacancies.
items:
$ref: '#/components/schemas/KeywordEntry'
publicationPeriod:
type:
- string
- "null"
enum:
- LAST_DAY
- LAST_THREE_DAYS
- LAST_WEEK
- LAST_MONTH
- LAST_VISIT
- null
description: |
Restricts results to vacancies published within the specified period.
`LAST_VISIT` requires an authenticated session. Pass `null` to disable
the publication date filter.
example: null
occupationUris:
type: array
description: |
List of ESCO occupation URI strings to filter by. An empty array applies
no occupation filter.
items:
type: string
format: uri
description: ESCO occupation URI (e.g. "http://data.europa.eu/esco/occupation/...")
example: []
skillUris:
type: array
description: |
List of ESCO skill URI strings to filter by. An empty array applies no
skill filter.
items:
type: string
format: uri
description: ESCO skill URI (e.g. "http://data.europa.eu/esco/skill/...")
example: []
requiredExperienceCodes:
type: array
description: |
Filter by required work experience level. An empty array applies no
experience filter. Use `NS` for "not specified".
items:
$ref: '#/components/schemas/ExperienceCode'
example: []
positionScheduleCodes:
type: array
description: |
Filter by working time arrangement. An empty array applies no schedule
filter. Use `NS` for "not specified".
items:
$ref: '#/components/schemas/PositionScheduleCode'
example: []
sectorCodes:
type: array
description: |
Filter by NACE economic sector. Values are lowercase single-letter NACE
division codes (e.g. `a` for Agriculture). An empty array applies no
sector filter. Use `NS` for "not specified".
items:
$ref: '#/components/schemas/SectorCode'
example: []
educationAndQualificationLevelCodes:
type: array
description: |
Filter by required education or qualification level. An empty array applies
no education filter. Use `NS` for "not specified".
items:
$ref: '#/components/schemas/EducationLevelCode'
example: []
positionOfferingCodes:
type: array
description: |
Filter by type of employment offering. An empty array applies no offering
type filter. Use `NS` for "not specified".
items:
$ref: '#/components/schemas/PositionOfferingCode'
example: []
locationCodes:
type: array
description: |
Filter by geographic location using NUTS (Nomenclature of Territorial Units
for Statistics) region codes. Codes can be country-level (e.g. `de`),
region-level (e.g. `de1`), or `NS` for "not specified". The suffix `-NS`
on a country code (e.g. `at-NS`) selects vacancies in that country where
the location is not specified.
items:
type: string
description: NUTS region code (lowercase) or country-NS suffix
example: []
euresFlagCodes:
type: array
description: |
Filter by EURES flag status. `WITH` returns only EURES-flagged vacancies.
`WITHOUT` returns only non-EURES-flagged vacancies. An empty array applies
no EURES flag filter.
items:
$ref: '#/components/schemas/EuresFlagCode'
example: []
otherBenefitsCodes:
type: array
description: |
Filter by additional employer benefit codes. Values are numeric codes
represented as strings. An empty array applies no benefits filter.
items:
type: string
description: Numeric benefit code as string
example: []
requiredLanguages:
type: array
description: |
Filter by required language proficiency. Each entry is a string in the
format `<isoCode>(<cefrLevel>)`, e.g. `de(C2)` for German at C2 level,
`en(B1)` for English at B1 level.
items:
type: string
description: Language proficiency requirement in format "<isoCode>(<cefrLevel>)"
pattern: "^[a-z]{2}\\([A-C][1-2]\\)$"
example: []
minNumberPost:
type:
- integer
- "null"
description: |
Minimum number of open positions required for a vacancy to be included in
results. Pass `null` to apply no minimum.
example: null
sessionId:
type: string
description: |
Client-generated session identifier string. Used by the EURES backend for
session tracking. Does not require authentication for public endpoints.
example: session-abc123
userPreferredLanguage:
type:
- string
- "null"
description: |
ISO 639-1 language code expressing the user's preferred language for content
retrieval. Pass `null` if no preference is set.
example: null
requestLanguage:
type: string
description: |
ISO 639-1 language code controlling the language of returned text content
such as job titles and descriptions. Must match a language code supported
by the /reference/languages endpoint.
example: en
KeywordEntry:
type: object
required:
- keyword
- specificSearchCode
properties:
keyword:
type: string
description: The search term or phrase to match against job vacancies.
example: software engineer
specificSearchCode:
type: string
description: |
Controls which fields the keyword is matched against. Values correspond
to the advanced search form fields on the EURES portal.
enum:
- EVERYWHERE
- TITLE
- DESCRIPTION
- EMPLOYER
- LEGAL_ID
- JOB_VACANCY_ID
example: EVERYWHERE
# -------------------------------------------------------------------------
# Response schemas
# -------------------------------------------------------------------------
JobSearchResponse:
type: object
required:
- numberRecords
- jvs
- facets
properties:
numberRecords:
type: integer
description: Total number of job vacancies matching the search criteria across all pages.
example: 1787657
jvs:
type: array
description: Page of job vacancy objects matching the search criteria.
items:
$ref: '#/components/schemas/JobVacancy'
facets:
$ref: '#/components/schemas/FacetMap'
JobVacancy:
type: object
required:
- title
- description
- id
- creationDate
- lastModificationDate
- numberOfPosts
- locationMap
- euresFlag
- jobCategoriesCodes
- positionScheduleCodes
- positionOfferingCode
- employer
- availableLanguages
- translationType
- translations
properties:
title:
type: string
description: Job vacancy title in the language determined by `requestLanguage`.
example: Software Engineer
description:
type: string
description: |
Full job description in the language determined by `requestLanguage`.
Content is HTML-formatted and may contain tags such as `<p>`, `<ul>`, `<li>`.
example: <p>We are looking for a Software Engineer...</p>
id:
type: string
description: |
Opaque vacancy identifier. Observed values are base64-encoded strings.
Use this value for deduplication and potential detail lookups.
example: MTAwMDEtMTAwMTEzOTMxMS1TIDE
creationDate:
type: integer
format: int64
description: Unix timestamp in milliseconds (epoch ms) when the vacancy was created.
example: 1739403609768
lastModificationDate:
type: integer
format: int64
description: Unix timestamp in milliseconds (epoch ms) of the last modification.
example: 1768605849756
numberOfPosts:
type: integer
minimum: 1
description: Number of open positions available for this vacancy.
example: 1
locationMap:
type: object