-
Notifications
You must be signed in to change notification settings - Fork 5
/
openapi.yaml
9255 lines (9255 loc) · 284 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.0
info:
title: Twitter API v2
description: Twitter API v2 available endpoints
version: '2.62'
contact:
name: Twitter Developers
url: https://developer.twitter.com/
x-twitter: twitter
license:
name: Twitter Developer Agreement and Policy
url: https://developer.twitter.com/en/developer-terms/agreement-and-policy.html
termsOfService: https://developer.twitter.com/en/developer-terms/agreement-and-policy.html
x-apisguru-categories:
- social
x-logo:
url: https://twitter.com/twitter/profile_image?size=original
x-origin:
- version: '3.0'
format: openapi
url: https://api.twitter.com/2/openapi.json
x-providerName: twitter.com
x-serviceName: current
x-tags:
- pii
x-konfig-ignore:
object-with-no-properties: true
potential-incorrect-type: true
servers:
- description: Twitter API
url: https://api.twitter.com
tags:
- description: Endpoints related to retrieving, searching, and modifying Tweets
externalDocs:
description: Find out more
url: https://developer.twitter.com/en/docs/twitter-api/tweets/lookup
name: Tweets
- description: Endpoints related to retrieving, managing relationships of Users
externalDocs:
description: Find out more
url: https://developer.twitter.com/en/docs/twitter-api/users/lookup
name: Users
- description: Endpoints related to retrieving, managing Lists
externalDocs:
description: Find out more
url: https://developer.twitter.com/en/docs/twitter-api/lists
name: Lists
- description: Endpoints related to keeping Twitter data in your systems compliant
externalDocs:
description: Find out more
url: >-
https://developer.twitter.com/en/docs/twitter-api/compliance/batch-tweet/introduction
name: Compliance
- description: Endpoints related to retrieving, managing Direct Messages
externalDocs:
description: Find out more
url: https://developer.twitter.com/en/docs/twitter-api/direct-messages
name: Direct Messages
- description: Endpoints related to retrieving, managing Spaces
externalDocs:
description: Find out more
url: https://developer.twitter.com/en/docs/twitter-api/spaces
name: Spaces
- description: Endpoints related to retrieving, managing bookmarks of a user
externalDocs:
description: Find out more
url: https://developer.twitter.com/en/docs/twitter-api/bookmarks
name: Bookmarks
- description: Miscellaneous endpoints for general API functionality
externalDocs:
description: Find out more
url: https://developer.twitter.com/en/docs/twitter-api
name: General
paths:
/2/compliance/jobs:
get:
tags:
- Compliance
summary: List Compliance Jobs
operationId: Compliance_listJobs
security:
- BearerToken: []
description: >-
Returns recent Compliance Jobs for a given job type and optional job
status
parameters:
- description: Type of Compliance Job to list.
in: query
name: type
required: true
schema:
enum:
- tweets
- users
type: string
style: form
- description: Status of Compliance Job to list.
in: query
name: status
required: false
schema:
enum:
- created
- in_progress
- failed
- complete
type: string
style: form
- $ref: '#/components/parameters/ComplianceJobFieldsParameter'
responses:
'200':
description: The request has succeeded.
content:
application/json:
schema:
$ref: '#/components/schemas/Get2ComplianceJobsResponse'
default:
description: The request has failed.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
externalDocs:
url: >-
https://developer.twitter.com/en/docs/twitter-api/compliance/batch-compliance/api-reference/get-compliance-jobs
post:
tags:
- Compliance
summary: Create compliance job
operationId: Compliance_createJob
security:
- BearerToken: []
description: Creates a compliance for the given job type
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateComplianceJobRequest'
required: true
responses:
'200':
description: The request has succeeded.
content:
application/json:
schema:
$ref: '#/components/schemas/CreateComplianceJobResponse'
default:
description: The request has failed.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
externalDocs:
url: >-
https://developer.twitter.com/en/docs/twitter-api/compliance/batch-compliance/api-reference/post-compliance-jobs
/2/compliance/jobs/{id}:
get:
tags:
- Compliance
summary: Get Compliance Job
operationId: Compliance_getJobById
security:
- BearerToken: []
description: Returns a single Compliance Job by ID
parameters:
- description: The ID of the Compliance Job to retrieve.
in: path
name: id
required: true
schema:
$ref: '#/components/schemas/JobId'
style: simple
- $ref: '#/components/parameters/ComplianceJobFieldsParameter'
responses:
'200':
description: The request has succeeded.
content:
application/json:
schema:
$ref: '#/components/schemas/Get2ComplianceJobsIdResponse'
default:
description: The request has failed.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
externalDocs:
url: >-
https://developer.twitter.com/en/docs/twitter-api/compliance/batch-compliance/api-reference/get-compliance-jobs-id
/2/dm_conversations:
post:
tags:
- Direct Messages
summary: Create a new DM Conversation
operationId: DirectMessages_createNewDmConversation
security:
- OAuth2UserToken:
- dm.write
- tweet.read
- users.read
- UserToken: []
description: Creates a new DM Conversation.
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateDmConversationRequest'
responses:
'201':
description: The request has succeeded.
content:
application/json:
schema:
$ref: '#/components/schemas/CreateDmEventResponse'
default:
description: The request has failed.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
/2/dm_conversations/with/{participant_id}/dm_events:
get:
tags:
- Direct Messages
summary: Get DM Events for a DM Conversation
operationId: DirectMessages_getDmEvents
security:
- OAuth2UserToken:
- dm.read
- tweet.read
- users.read
- UserToken: []
description: Returns DM Events for a DM Conversation
parameters:
- description: The ID of the participant user for the One to One DM conversation.
in: path
name: participant_id
required: true
schema:
$ref: '#/components/schemas/UserId'
style: simple
- description: The maximum number of results.
in: query
name: max_results
required: false
schema:
default: 100
format: int32
maximum: 100
minimum: 1
type: integer
style: form
- description: This parameter is used to get a specified 'page' of results.
in: query
name: pagination_token
required: false
schema:
$ref: '#/components/schemas/PaginationToken32'
style: form
- description: The set of event_types to include in the results.
explode: false
in: query
name: event_types
required: false
schema:
default:
- MessageCreate
- ParticipantsLeave
- ParticipantsJoin
example:
- MessageCreate
- ParticipantsLeave
items:
enum:
- MessageCreate
- ParticipantsJoin
- ParticipantsLeave
type: string
minItems: 1
type: array
uniqueItems: true
style: form
- $ref: '#/components/parameters/DmEventFieldsParameter'
- $ref: '#/components/parameters/DmEventExpansionsParameter'
- $ref: '#/components/parameters/MediaFieldsParameter'
- $ref: '#/components/parameters/UserFieldsParameter'
- $ref: '#/components/parameters/TweetFieldsParameter'
responses:
'200':
description: The request has succeeded.
content:
application/json:
schema:
$ref: >-
#/components/schemas/Get2DmConversationsWithParticipantIdDmEventsResponse
default:
description: The request has failed.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
/2/dm_conversations/with/{participant_id}/messages:
post:
tags:
- Direct Messages
summary: Send a new message to a user
operationId: DirectMessages_sendNewMessageToUser
security:
- OAuth2UserToken:
- dm.write
- tweet.read
- users.read
- UserToken: []
description: >-
Creates a new message for a DM Conversation with a participant user by
ID
parameters:
- description: The ID of the recipient user that will receive the DM.
in: path
name: participant_id
required: true
schema:
$ref: '#/components/schemas/UserId'
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateMessageRequest'
responses:
'201':
description: The request has succeeded.
content:
application/json:
schema:
$ref: '#/components/schemas/CreateDmEventResponse'
default:
description: The request has failed.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
/2/dm_conversations/{dm_conversation_id}/messages:
post:
tags:
- Direct Messages
summary: Send a new message to a DM Conversation
operationId: DirectMessages_sendNewMessageToDmConversation
security:
- OAuth2UserToken:
- dm.write
- tweet.read
- users.read
- UserToken: []
description: >-
Creates a new message for a DM Conversation specified by DM Conversation
ID
parameters:
- description: The DM Conversation ID.
in: path
name: dm_conversation_id
required: true
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateMessageRequest'
responses:
'201':
description: The request has succeeded.
content:
application/json:
schema:
$ref: '#/components/schemas/CreateDmEventResponse'
default:
description: The request has failed.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
/2/dm_conversations/{id}/dm_events:
get:
tags:
- Direct Messages
summary: Get DM Events for a DM Conversation
operationId: DirectMessages_getDmEvents
security:
- OAuth2UserToken:
- dm.read
- tweet.read
- users.read
- UserToken: []
description: Returns DM Events for a DM Conversation
parameters:
- description: The DM Conversation ID.
in: path
name: id
required: true
schema:
$ref: '#/components/schemas/DmConversationId'
style: simple
- description: The maximum number of results.
in: query
name: max_results
required: false
schema:
default: 100
format: int32
maximum: 100
minimum: 1
type: integer
style: form
- description: This parameter is used to get a specified 'page' of results.
in: query
name: pagination_token
required: false
schema:
$ref: '#/components/schemas/PaginationToken32'
style: form
- description: The set of event_types to include in the results.
explode: false
in: query
name: event_types
required: false
schema:
default:
- MessageCreate
- ParticipantsLeave
- ParticipantsJoin
example:
- MessageCreate
- ParticipantsLeave
items:
enum:
- MessageCreate
- ParticipantsJoin
- ParticipantsLeave
type: string
minItems: 1
type: array
uniqueItems: true
style: form
- $ref: '#/components/parameters/DmEventFieldsParameter'
- $ref: '#/components/parameters/DmEventExpansionsParameter'
- $ref: '#/components/parameters/MediaFieldsParameter'
- $ref: '#/components/parameters/UserFieldsParameter'
- $ref: '#/components/parameters/TweetFieldsParameter'
responses:
'200':
description: The request has succeeded.
content:
application/json:
schema:
$ref: '#/components/schemas/Get2DmConversationsIdDmEventsResponse'
default:
description: The request has failed.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
/2/dm_events:
get:
tags:
- Direct Messages
summary: Get recent DM Events
operationId: DirectMessages_getRecentDmEvents
security:
- OAuth2UserToken:
- dm.read
- tweet.read
- users.read
- UserToken: []
description: Returns recent DM Events across DM conversations
parameters:
- description: The maximum number of results.
in: query
name: max_results
required: false
schema:
default: 100
format: int32
maximum: 100
minimum: 1
type: integer
style: form
- description: This parameter is used to get a specified 'page' of results.
in: query
name: pagination_token
required: false
schema:
$ref: '#/components/schemas/PaginationToken32'
style: form
- description: The set of event_types to include in the results.
explode: false
in: query
name: event_types
required: false
schema:
default:
- MessageCreate
- ParticipantsLeave
- ParticipantsJoin
example:
- MessageCreate
- ParticipantsLeave
items:
enum:
- MessageCreate
- ParticipantsJoin
- ParticipantsLeave
type: string
minItems: 1
type: array
uniqueItems: true
style: form
- $ref: '#/components/parameters/DmEventFieldsParameter'
- $ref: '#/components/parameters/DmEventExpansionsParameter'
- $ref: '#/components/parameters/MediaFieldsParameter'
- $ref: '#/components/parameters/UserFieldsParameter'
- $ref: '#/components/parameters/TweetFieldsParameter'
responses:
'200':
description: The request has succeeded.
content:
application/json:
schema:
$ref: '#/components/schemas/Get2DmEventsResponse'
default:
description: The request has failed.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
/2/lists:
post:
tags:
- Lists
summary: Create List
operationId: Lists_createNewList
security:
- OAuth2UserToken:
- list.read
- list.write
- tweet.read
- users.read
- UserToken: []
description: Creates a new List.
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ListCreateRequest'
responses:
'200':
description: The request has succeeded.
content:
application/json:
schema:
$ref: '#/components/schemas/ListCreateResponse'
default:
description: The request has failed.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
externalDocs:
url: >-
https://developer.twitter.com/en/docs/twitter-api/lists/manage-lists/api-reference/post-lists
/2/lists/{id}:
delete:
tags:
- Lists
summary: Delete List
operationId: Lists_deleteOwnedList
security:
- OAuth2UserToken:
- list.write
- tweet.read
- users.read
- UserToken: []
description: Delete a List that you own.
parameters:
- description: The ID of the List to delete.
in: path
name: id
required: true
schema:
$ref: '#/components/schemas/ListId'
style: simple
responses:
'200':
description: The request has succeeded.
content:
application/json:
schema:
$ref: '#/components/schemas/ListDeleteResponse'
default:
description: The request has failed.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
externalDocs:
url: >-
https://developer.twitter.com/en/docs/twitter-api/lists/manage-lists/api-reference/delete-lists-id
get:
tags:
- Lists
summary: List lookup by List ID.
operationId: Lists_lookupByListId
security:
- BearerToken: []
- OAuth2UserToken:
- list.read
- tweet.read
- users.read
- UserToken: []
description: Returns a List.
parameters:
- description: The ID of the List.
in: path
name: id
required: true
schema:
$ref: '#/components/schemas/ListId'
style: simple
- $ref: '#/components/parameters/ListFieldsParameter'
- $ref: '#/components/parameters/ListExpansionsParameter'
- $ref: '#/components/parameters/UserFieldsParameter'
responses:
'200':
description: The request has succeeded.
content:
application/json:
schema:
$ref: '#/components/schemas/Get2ListsIdResponse'
default:
description: The request has failed.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
externalDocs:
url: >-
https://developer.twitter.com/en/docs/twitter-api/lists/list-lookup/api-reference/get-lists-id
put:
tags:
- Lists
summary: Update List.
operationId: Lists_updateOwnedList
security:
- OAuth2UserToken:
- list.write
- tweet.read
- users.read
- UserToken: []
description: Update a List that you own.
parameters:
- description: The ID of the List to modify.
in: path
name: id
required: true
schema:
$ref: '#/components/schemas/ListId'
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ListUpdateRequest'
responses:
'200':
description: The request has succeeded.
content:
application/json:
schema:
$ref: '#/components/schemas/ListUpdateResponse'
default:
description: The request has failed.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
externalDocs:
url: >-
https://developer.twitter.com/en/docs/twitter-api/lists/manage-lists/api-reference/put-lists-id
/2/lists/{id}/followers:
get:
tags:
- Users
summary: Returns User objects that follow a List by the provided List ID
operationId: Users_getFollowersByListId
security:
- BearerToken: []
- OAuth2UserToken:
- list.read
- tweet.read
- users.read
- UserToken: []
description: Returns a list of Users that follow a List by the provided List ID
parameters:
- description: The ID of the List.
in: path
name: id
required: true
schema:
$ref: '#/components/schemas/ListId'
style: simple
- description: The maximum number of results.
in: query
name: max_results
required: false
schema:
default: 100
format: int32
maximum: 100
minimum: 1
type: integer
style: form
- description: This parameter is used to get a specified 'page' of results.
in: query
name: pagination_token
required: false
schema:
$ref: '#/components/schemas/PaginationTokenLong'
style: form
- $ref: '#/components/parameters/UserFieldsParameter'
- $ref: '#/components/parameters/UserExpansionsParameter'
- $ref: '#/components/parameters/TweetFieldsParameter'
responses:
'200':
description: The request has succeeded.
content:
application/json:
schema:
$ref: '#/components/schemas/Get2ListsIdFollowersResponse'
default:
description: The request has failed.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
externalDocs:
url: >-
https://developer.twitter.com/en/docs/twitter-api/users/follows/api-reference/get-users-id-followers
/2/lists/{id}/members:
get:
tags:
- Users
summary: Returns User objects that are members of a List by the provided List ID.
operationId: Users_getMembersByListId
security:
- BearerToken: []
- OAuth2UserToken:
- list.read
- tweet.read
- users.read
- UserToken: []
description: >-
Returns a list of Users that are members of a List by the provided List
ID.
parameters:
- description: The ID of the List.
in: path
name: id
required: true
schema:
$ref: '#/components/schemas/ListId'
style: simple
- description: The maximum number of results.
in: query
name: max_results
required: false
schema:
default: 100
format: int32
maximum: 100
minimum: 1
type: integer
style: form
- description: This parameter is used to get a specified 'page' of results.
in: query
name: pagination_token
required: false
schema:
$ref: '#/components/schemas/PaginationTokenLong'
style: form
- $ref: '#/components/parameters/UserFieldsParameter'
- $ref: '#/components/parameters/UserExpansionsParameter'
- $ref: '#/components/parameters/TweetFieldsParameter'
responses:
'200':
description: The request has succeeded.
content:
application/json:
schema:
$ref: '#/components/schemas/Get2ListsIdMembersResponse'
default:
description: The request has failed.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
externalDocs:
url: >-
https://developer.twitter.com/en/docs/twitter-api/lists/list-members/api-reference/get-users-id-list_memberships
post:
tags:
- Lists
summary: Add a List member
operationId: Lists_addMember
security:
- OAuth2UserToken:
- list.write
- tweet.read
- users.read
- UserToken: []
description: Causes a User to become a member of a List.
parameters:
- description: The ID of the List for which to add a member.
in: path
name: id
required: true
schema:
$ref: '#/components/schemas/ListId'
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ListAddUserRequest'
responses:
'200':
description: The request has succeeded.
content:
application/json:
schema:
$ref: '#/components/schemas/ListMutateResponse'
default:
description: The request has failed.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
externalDocs:
url: >-
https://developer.twitter.com/en/docs/twitter-api/lists/list-members/api-reference/post-lists-id-members
/2/lists/{id}/members/{user_id}:
delete:
tags:
- Lists
summary: Remove a List member
operationId: Lists_removeMember
security:
- OAuth2UserToken:
- list.write
- tweet.read
- users.read
- UserToken: []
description: Causes a User to be removed from the members of a List.
parameters:
- description: The ID of the List to remove a member.
in: path
name: id
required: true
schema:
$ref: '#/components/schemas/ListId'
style: simple
- description: The ID of User that will be removed from the List.
in: path
name: user_id
required: true
schema:
$ref: '#/components/schemas/UserId'
style: simple
responses:
'200':
description: The request has succeeded.
content:
application/json:
schema:
$ref: '#/components/schemas/ListMutateResponse'
default:
description: The request has failed.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
externalDocs:
url: >-
https://developer.twitter.com/en/docs/twitter-api/lists/list-members/api-reference/delete-lists-id-members-user_id
/2/lists/{id}/tweets:
get:
tags:
- Tweets
summary: List Tweets timeline by List ID.
operationId: Tweets_listByListId
security:
- BearerToken: []
- OAuth2UserToken:
- list.read
- tweet.read
- users.read
- UserToken: []
description: Returns a list of Tweets associated with the provided List ID.
parameters:
- description: The ID of the List.
in: path
name: id
required: true
schema:
$ref: '#/components/schemas/ListId'
style: simple
- description: The maximum number of results.
in: query
name: max_results
required: false
schema:
default: 100
format: int32
maximum: 100
minimum: 1
type: integer
style: form
- description: This parameter is used to get the next 'page' of results.
in: query
name: pagination_token
required: false
schema:
$ref: '#/components/schemas/PaginationToken36'
style: form
- $ref: '#/components/parameters/TweetFieldsParameter'
- $ref: '#/components/parameters/TweetExpansionsParameter'
- $ref: '#/components/parameters/MediaFieldsParameter'
- $ref: '#/components/parameters/PollFieldsParameter'
- $ref: '#/components/parameters/UserFieldsParameter'
- $ref: '#/components/parameters/PlaceFieldsParameter'
responses:
'200':
description: The request has succeeded.
content:
application/json:
schema: