-
Notifications
You must be signed in to change notification settings - Fork 5
/
openapi.yaml
4968 lines (4923 loc) · 160 KB
/
openapi.yaml
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.0.3
info:
title: TheirStack API Reference
description: >+
# Introduction
Welcome to TheirStack’s API!
<br>
You can use this API to access all our API endpoints, such as the [Jobs
endpoint](https://api.theirstack.com) to get real-time and historical jobs
from more than 100 countries or the [Companies
endpoint](https://api.theirstack.com) to get a list of companies by the
technology they use or by the roles they are hiring for.
The API is organized around [REST](https://en.wikipedia.org/wiki/REST). All
requests should be made over SSL. All request and response bodies, including
errors, are encoded in JSON.
# Authentication
Authentication is done via the API key which you can find in [your account
settings](https://app.theirstack.com/settings/api).
When making a call, you’ll have to specify this API key with the
Authorization header. Here’s an example:
```sh
Authorization: Bearer <token>
```
version: 1.0.0
x-konfig-ignore:
object-with-no-properties: true
potential-incorrect-type: true
servers:
- url: https://api.theirstack.com
tags:
- name: Company Lists
- name: Saved Searches
- name: Catalog
- description: Operations with companies
name: Companies
- description: Operations with jobs
name: Jobs
- description: Finding decision makers
name: Decision makers
paths:
/v0/company_lists:
get:
tags:
- Company Lists
summary: Get Lists
operationId: CompanyLists_getAllLists
security:
- APIKeyQuery: []
- APIKeyCookie: []
- Bearer: []
- OAuth2PasswordBearer: []
description: Get all the lists for the current user
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/CompanyListsGetAllListsResponse'
post:
tags:
- Company Lists
summary: Create List
operationId: CompanyLists_createList
security:
- APIKeyQuery: []
- APIKeyCookie: []
- Bearer: []
- OAuth2PasswordBearer: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CompanyListCreate'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/CompanyList'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v0/company_lists/{list_id}:
get:
tags:
- Company Lists
summary: Get List
operationId: CompanyLists_getList
security:
- APIKeyQuery: []
- APIKeyCookie: []
- Bearer: []
- OAuth2PasswordBearer: []
parameters:
- required: true
schema:
title: List Id
type: integer
name: list_id
in: path
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/CompanyList'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- Company Lists
summary: Delete List
operationId: CompanyLists_removeList
security:
- APIKeyQuery: []
- APIKeyCookie: []
- Bearer: []
- OAuth2PasswordBearer: []
parameters:
- required: true
schema:
title: List Id
type: integer
name: list_id
in: path
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/CompanyListsRemoveListResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
patch:
tags:
- Company Lists
summary: Rename List
operationId: CompanyLists_renameList
security:
- APIKeyQuery: []
- APIKeyCookie: []
- Bearer: []
- OAuth2PasswordBearer: []
parameters:
- required: true
schema:
title: List Id
type: integer
name: list_id
in: path
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CompanyListRename'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/CompanyList'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v0/company_lists/{list_id}/companies:
get:
tags:
- Company Lists
summary: Get List Companies
operationId: CompanyLists_getListCompanies
security:
- APIKeyQuery: []
- APIKeyCookie: []
- Bearer: []
- OAuth2PasswordBearer: []
parameters:
- required: true
schema:
title: List Id
type: integer
name: list_id
in: path
- description: Order by field
required: false
schema:
title: Order By
description: Order by field
type: string
enum:
- added_at_last_time
- name
default: added_at_last_time
name: order_by
in: query
- description: Order direction
required: false
schema:
title: Order Direction
description: Order direction
type: string
enum:
- asc
- desc
default: desc
name: order_direction
in: query
- description: Pass a partial company name to filter the list of companies
required: false
schema:
title: Company Name Partial
description: Pass a partial company name to filter the list of companies
type: string
name: company_name_partial
in: query
- required: false
schema:
title: Page
type: integer
default: 0
name: page
in: query
- required: false
schema:
title: Limit
type: integer
default: 25
name: limit
in: query
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/CompanyListsGetListCompaniesResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v0/company_lists/{list_id}/add_companies:
post:
tags:
- Company Lists
summary: Add Companies To List
operationId: CompanyLists_addCompaniesToList
security:
- APIKeyQuery: []
- APIKeyCookie: []
- Bearer: []
- OAuth2PasswordBearer: []
parameters:
- required: true
schema:
title: List Id
type: integer
name: list_id
in: path
requestBody:
content:
application/json:
schema:
$ref: >-
#/components/schemas/Body_add_companies_to_list_v0_company_lists__list_id__add_companies_post
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/CompanyList'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v0/company_lists/{list_id}/remove_companies:
post:
tags:
- Company Lists
summary: Remove Companies From List
operationId: CompanyLists_removeCompaniesFromList
security:
- APIKeyQuery: []
- APIKeyCookie: []
- Bearer: []
- OAuth2PasswordBearer: []
parameters:
- required: true
schema:
title: List Id
type: integer
name: list_id
in: path
requestBody:
content:
application/json:
schema:
$ref: >-
#/components/schemas/Body_remove_companies_from_list_v0_company_lists__list_id__remove_companies_post
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/CompanyList'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v0/company_lists/add_companies:
post:
tags:
- Company Lists
summary: Add Companies To Multiple Lists
operationId: CompanyLists_addCompaniesToMultipleLists
security:
- APIKeyQuery: []
- APIKeyCookie: []
- Bearer: []
- OAuth2PasswordBearer: []
requestBody:
content:
application/json:
schema:
$ref: >-
#/components/schemas/Body_add_companies_to_multiple_lists_v0_company_lists_add_companies_post
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: >-
#/components/schemas/CompanyListsAddCompaniesToMultipleListsResponse
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v0/saved_searches:
get:
tags:
- Saved Searches
summary: Get Saved Searches
operationId: SavedSearches_getAll
security:
- APIKeyQuery: []
- APIKeyCookie: []
- Bearer: []
- OAuth2PasswordBearer: []
description: Get all the saved searches for the current user
parameters:
- description: >-
Get saved searches from users with these IDs. The IDs must be from
people in the current users' team.
required: false
schema:
title: User Ids
description: >-
Get saved searches from users with these IDs. The IDs must be from
people in the current users' team.
items:
type: integer
type: array
name: user_ids
in: query
- description: Filter by type of search. For example, 'jobs' or 'tech_details'
required: false
schema:
title: Types
description: Filter by type of search. For example, 'jobs' or 'tech_details'
items:
type: string
type: array
name: types
in: query
- description: Order by field
required: false
schema:
title: Order By
description: Order by field
type: string
enum:
- name
- created_at
- updated_at
default: updated_at
name: order_by
in: query
- description: Order direction
required: false
schema:
title: Order Direction
description: Order direction
type: string
enum:
- asc
- desc
default: desc
name: order_direction
in: query
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/SavedSearchesGetAllResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
put:
tags:
- Saved Searches
summary: Upsert Saved Search
operationId: SavedSearches_upsertSavedSearch
security:
- APIKeyQuery: []
- APIKeyCookie: []
- Bearer: []
- OAuth2PasswordBearer: []
description: >-
Create or update a saved search. If one with the same name and type
exists, it will be updated. If not, a new one will be created.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SavedSearchCreate'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/SavedSearch'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
post:
tags:
- Saved Searches
summary: Create Saved Search
operationId: SavedSearches_createSearch
security:
- APIKeyQuery: []
- APIKeyCookie: []
- Bearer: []
- OAuth2PasswordBearer: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SavedSearchCreate'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/SavedSearch'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v0/saved_searches/{search_id}:
get:
tags:
- Saved Searches
summary: Get Saved Search
operationId: SavedSearches_getDetails
security:
- APIKeyQuery: []
- APIKeyCookie: []
- Bearer: []
- OAuth2PasswordBearer: []
parameters:
- required: true
schema:
title: Search Id
type: integer
name: search_id
in: path
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/SavedSearch'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- Saved Searches
summary: Delete Saved Search
operationId: SavedSearches_deleteSearch
security:
- APIKeyQuery: []
- APIKeyCookie: []
- Bearer: []
- OAuth2PasswordBearer: []
parameters:
- required: true
schema:
title: Search Id
type: integer
name: search_id
in: path
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/SavedSearchesDeleteSearchResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
patch:
tags:
- Saved Searches
summary: Update Saved Search
operationId: SavedSearches_updateSearch
security:
- APIKeyQuery: []
- APIKeyCookie: []
- Bearer: []
- OAuth2PasswordBearer: []
parameters:
- required: true
schema:
title: Search Id
type: integer
name: search_id
in: path
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SavedSearchUpdate'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/SavedSearch'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v0/catalog/technologies:
get:
tags:
- Catalog
summary: Get Technologies
operationId: Catalog_getTechnologies
description: >-
This endpoint lets you:
- List all the technologies we track
- Search for any given technology. Pass a `name_pattern` parameter
(case-insensitive, can be a regex pattern)
- List the technologies within one or several categories. Pass a
`category_pattern` parameter (case-insensitive, can be a regex pattern)
Calls to this endpoint don't cost you credits.
parameters:
- description: Regex pattern of a technology name, case-insensitive
required: false
schema:
title: Name Pattern
description: Regex pattern of a technology name, case-insensitive
type: string
name: name_pattern
in: query
- description: >-
Regex pattern of a technology category, case-insensitive. For
example, `data|storage|queue` to find data tools.
required: false
schema:
title: Category Pattern
description: >-
Regex pattern of a technology category, case-insensitive. For
example, `data|storage|queue` to find data tools.
type: string
name: category_pattern
in: query
- description: Slug of one or many technologies
required: false
schema:
title: Slug
description: Slug of one or many technologies
items:
type: string
type: array
name: slug
in: query
- description: Slugs of one or many technologies
required: false
schema:
title: Slugs
description: Slugs of one or many technologies
items:
type: string
type: array
name: slugs
in: query
- description: Slug of a technology category
required: false
schema:
title: Category Slug
description: Slug of a technology category
type: string
name: category_slug
in: query
- required: false
schema:
title: Page
type: integer
default: 0
name: page
in: query
- required: false
schema:
title: Limit
type: integer
default: 25
name: limit
in: query
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/CatalogGetTechnologiesResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v0/catalog/industries:
get:
tags:
- Catalog
summary: Get Industries
operationId: Catalog_getIndustries
description: |-
This endpoint lets you:
- List all the industries and their codes
- See how many jobs and companies we have per industry
- Search for an industry
Calls to this endpoint don't cost you credits.
parameters:
- description: >-
Name of an industry, case-insensitive. Will return industries that
contain the given string either in their name, hierarchy or
description
required: false
schema:
title: Industry
description: >-
Name of an industry, case-insensitive. Will return industries that
contain the given string either in their name, hierarchy or
description
type: string
name: industry
in: query
- required: false
schema:
title: Page
type: integer
default: 0
name: page
in: query
- required: false
schema:
title: Limit
type: integer
default: 25
name: limit
in: query
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/IndustryStatsResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v0/catalog/jobs_companies_per_job_country_code:
get:
tags:
- Catalog
summary: Get Jobs And Companies Per Job Country Code
operationId: Catalog_getJobsAndCompaniesPerJobCountryCode
description: >-
This endpoint will return all the country codes and the number of jobs
whose location's country code is the given one, and the number of
companies with jobs in that country.
Calls to this endpoint don't cost you credits.
parameters:
- description: >-
Name of a country. Will return any countries that contain the given
string
required: false
schema:
title: Country
description: >-
Name of a country. Will return any countries that contain the
given string
type: string
name: country
in: query
- required: false
schema:
title: Page
type: integer
default: 0
name: page
in: query
- required: false
schema:
title: Limit
type: integer
default: 25
name: limit
in: query
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/JobsCompaniesPerJobCountryCodeResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v0/catalog/companies_per_company_country_code:
get:
tags:
- Catalog
summary: Get Companies Per Company Country Code
operationId: Catalog_getCompaniesPerCountryCode
description: >-
This endpoint will return all country codes and the number of companies
whose HQ is in that country.
Calls to this endpoint don't cost you credits.
parameters:
- description: >-
Name of a country. Will return any countries that contain the given
string
required: false
schema:
title: Country
description: >-
Name of a country. Will return any countries that contain the
given string
type: string
name: country
in: query
- required: false
schema:
title: Page
type: integer
default: 0
name: page
in: query
- required: false
schema:
title: Limit
type: integer
default: 25
name: limit
in: query
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/CompaniesPerCountryCodeResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v0/catalog/technologies/categories:
get:
tags:
- Catalog
summary: Get Technology Categories
operationId: Catalog_listTechnologyCategories
description: >-
This endpoint lets you get all the categories of the technologies we
monitor, and the number of technologies and companies in each category.
parameters:
- description: Category slug
required: false
schema:
title: Category Slug
description: Category slug
type: string
name: category_slug
in: query
- description: Number of technologies per category
required: false
schema:
title: Num Technologies Per Category
description: Number of technologies per category
type: integer
default: 5
name: num_technologies_per_category
in: query
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/TechnologyCategoryResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/jobs/search:
post:
tags:
- Jobs
summary: Search Jobs
operationId: Jobs_searchByCriteria
security:
- APIKeyQuery: []
- APIKeyCookie: []
- Bearer: []
- OAuth2PasswordBearer: []
description: >-
This endpoints lets you find the most recent jobs, filter them by
companies, technologies or any pattern in the job description.
parameters:
- description: Page number. Will only apply when not passed in the body
required: false
schema:
title: Page
description: Page number. Will only apply when not passed in the body
type: integer
name: page
in: query
- description: >-
Number of results per page. Will only apply when not passed in the
body.
required: false
schema:
title: Limit
description: >-
Number of results per page. Will only apply when not passed in the
body.
type: integer
name: limit
in: query
- description: >-
Whether to include the total number of results in the response. Will
only apply when not passed in the body.
required: false
schema:
title: Include Total Results
description: >-
Whether to include the total number of results in the response.
Will only apply when not passed in the body.
type: boolean
name: include_total_results
in: query
- description: >-
Group results by a given field and get the number of jobs per group.
If you pass `company`, you'll get the number of jobs per company. If
you pass `job_title`, you'll get the number of jobs per job title.
If you pass `location`, you'll get the number of jobs per location.
Will only apply when not passed in the body
required: false
schema:
title: Group By
description: >-
Group results by a given field and get the number of jobs per
group. If you pass `company`, you'll get the number of jobs per
company. If you pass `job_title`, you'll get the number of jobs
per job title. If you pass `location`, you'll get the number of
jobs per location. Will only apply when not passed in the body
items:
type: string
type: array
name: group_by
in: query
- description: Format of the response. One of `json` or `csv`. Defaults to `json`.
required: false
schema:
title: Format
description: >-
Format of the response. One of `json` or `csv`. Defaults to
`json`.
type: string
enum:
- json
- csv
default: json
name: format
in: query
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/JobSearchFilters'
required: true
responses:
'200':