Returns a list of Users that are members of a List by the provided List ID.
643 matches
77 actions
Twitter API v2
77 actions
- Add a List memberPOSTv1.0.0
- Add Tweet to BookmarksPOSTv1.0.0
- Add/Delete rulesPOSTv1.0.0
- Block User by User IDPOSTv1.0.0
- Bookmarks by UserGETv1.0.0
- Causes the User (in the path) to like the specified TweetPOSTv1.0.0
- Causes the User (in the path) to retweet the specified Tweet.POSTv1.0.0
- Causes the User (in the path) to unlike the specified TweetDELETEv1.0.0
- Causes the User (in the path) to unretweet the specified TweetDELETEv1.0.0
- Create a new DM ConversationPOSTv1.0.0
- Create ListPOSTv1.0.0
- Creation of a TweetPOSTv1.0.0
- Delete ListDELETEv1.0.0
- Filtered streamGETv1.0.0
- Firehose streamGETv1.0.0
- Follow a ListPOSTv1.0.0
- Follow UserPOSTv1.0.0
- Followers by User IDGETv1.0.0
- Following by User IDGETv1.0.0
- Full archive search countsGETv1.0.0
- Full-archive searchGETv1.0.0
- Get a User's List MembershipsGETv1.0.0
- Get a User's Owned Lists.GETv1.0.0
- Get a User's Pinned ListsGETv1.0.0
- Get DM Events for a DM ConversationGETv1.0.0
- Get DM Events for a DM ConversationGETv1.0.0
- Get recent DM EventsGETv1.0.0
- Get User's Followed ListsGETv1.0.0
- Hide repliesPUTv1.0.0
- List lookup by List ID.GETv1.0.0
- List Tweets timeline by List ID.GETv1.0.0
- Mute User by User ID.POSTv1.0.0
- Pin a ListPOSTv1.0.0
- Recent searchGETv1.0.0
- Recent search countsGETv1.0.0
- Remove a bookmarked TweetDELETEv1.0.0
- Remove a List memberDELETEv1.0.0
- Retrieve the list of Users who purchased a ticket to the given spaceGETv1.0.0
- Retrieve Tweets from a Space.GETv1.0.0
- Retrieve Tweets that quote a Tweet.GETv1.0.0
- Returns the OpenAPI Specification document.GETv1.0.0
- Returns Tweet objects liked by the provided User IDGETv1.0.0
- Returns User objects that are blocked by provided User IDGETv1.0.0
- Returns User objects that are members of a List by the provided List ID.GETv1.0.0
- Returns User objects that are muted by the provided User IDGETv1.0.0
- Returns User objects that follow a List by the provided List IDGETv1.0.0
- Returns User objects that have liked the provided Tweet IDGETv1.0.0
- Returns User objects that have retweeted the provided Tweet IDGETv1.0.0
- Rules lookupGETv1.0.0
- Sample 10% streamGETv1.0.0
- Sample streamGETv1.0.0
- Search for SpacesGETv1.0.0
- Send a new message to a DM ConversationPOSTv1.0.0
- Send a new message to a userPOSTv1.0.0
- Space lookup by Space IDGETv1.0.0
- Space lookup by their creatorsGETv1.0.0
- Space lookup up Space IDsGETv1.0.0
- Tweet delete by Tweet IDDELETEv1.0.0
- Tweet lookup by Tweet IDGETv1.0.0
- Tweet lookup by Tweet IDsGETv1.0.0
- Tweets Compliance streamGETv1.0.0
- Tweets Label streamGETv1.0.0
- Unblock User by User IDDELETEv1.0.0
- Unfollow a ListDELETEv1.0.0
- Unfollow UserDELETEv1.0.0
- Unmute User by User IDDELETEv1.0.0
- Unpin a ListDELETEv1.0.0
- Update List.PUTv1.0.0
- User home timeline by User IDGETv1.0.0
- User lookup by IDGETv1.0.0
- User lookup by IDsGETv1.0.0
- User lookup by usernameGETv1.0.0
- User lookup by usernamesGETv1.0.0
- User lookup meGETv1.0.0
- User mention timeline by User IDGETv1.0.0
- User Tweets timeline by User IDGETv1.0.0
- Users Compliance streamGETv1.0.0
Social/Twitter API v2
Returns User objects that are members of a List by the provided List ID.
v1.0.0Input
- 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
{
"type": "object",
"properties": {
"expansions": {
"type": "array",
"description": "The list of fields you can expand for a [User](#User) object. If the field has an ID, it can be expanded into a full object.",
"items": {
"type": "string",
"enum": [
"pinned_tweet_id"
]
}
},
"id": {
"type": "string",
"description": "The unique identifier of this List."
},
"max_results": {
"type": "integer",
"format": "int32"
},
"pagination_token": {
"type": "string",
"description": "A 'long' pagination token."
},
"tweet.fields": {
"type": "array",
"description": "The fields available for a Tweet object.",
"items": {
"type": "string",
"enum": [
"attachments",
"author_id",
"context_annotations",
"conversation_id",
"created_at",
"edit_controls",
"edit_history_tweet_ids",
"entities",
"geo",
"id",
"in_reply_to_user_id",
"lang",
"non_public_metrics",
"organic_metrics",
"possibly_sensitive",
"promoted_metrics",
"public_metrics",
"referenced_tweets",
"reply_settings",
"source",
"text",
"withheld"
]
}
},
"user.fields": {
"type": "array",
"description": "The fields available for a User object.",
"items": {
"type": "string",
"enum": [
"created_at",
"description",
"entities",
"id",
"location",
"name",
"pinned_tweet_id",
"profile_image_url",
"protected",
"public_metrics",
"url",
"username",
"verified",
"verified_type",
"withheld"
]
}
}
},
"required": [
"id"
],
"additionalProperties": false
}Output
- 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
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"description": "The Twitter User object.",
"required": [
"id",
"name",
"username"
],
"properties": {
"created_at": {
"type": "string",
"format": "date-time",
"description": "Creation time of this User."
},
"description": {
"type": "string",
"description": "The text of this User's profile description (also known as bio), if the User provided one."
},
"entities": {
"type": "object",
"description": "A list of metadata found in the User's profile description.",
"properties": {
"description": {
"type": "object",
"properties": {
"annotations": {
"type": "array",
"items": {
"description": "Annotation for entities based on the Tweet text.",
"type": "object"
}
},
"cashtags": {
"type": "array",
"items": {
"type": "object"
}
},
"hashtags": {
"type": "array",
"items": {
"type": "object"
}
},
"mentions": {
"type": "array",
"items": {
"type": "object"
}
},
"urls": {
"type": "array",
"items": {
"description": "Represent the portion of text recognized as a URL, and its start and end position within the text.",
"type": "object"
}
}
}
},
"url": {
"type": "object",
"description": "Expanded details for the URL specified in the User's profile, with start and end indices.",
"properties": {
"urls": {
"type": "array",
"items": {
"description": "Represent the portion of text recognized as a URL, and its start and end position within the text.",
"type": "object"
}
}
}
}
}
},
"id": {
"type": "string",
"description": "Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers."
},
"location": {
"type": "string",
"description": "The location specified in the User's profile, if the User provided one. As this is a freeform value, it may not indicate a valid location, but it may be fuzzily evaluated when performing searches with location queries."
},
"name": {
"type": "string",
"description": "The friendly name of this User, as shown on their profile."
},
"pinned_tweet_id": {
"type": "string",
"description": "Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers."
},
"profile_image_url": {
"type": "string",
"format": "uri",
"description": "The URL to the profile image for this User."
},
"protected": {
"type": "boolean",
"description": "Indicates if this User has chosen to protect their Tweets (in other words, if this User's Tweets are private)."
},
"public_metrics": {
"type": "object",
"description": "A list of metrics for this User.",
"required": [
"followers_count",
"following_count",
"tweet_count",
"listed_count"
],
"properties": {
"followers_count": {
"type": "integer",
"description": "Number of Users who are following this User."
},
"following_count": {
"type": "integer",
"description": "Number of Users this User is following."
},
"listed_count": {
"type": "integer",
"description": "The number of lists that include this User."
},
"tweet_count": {
"type": "integer",
"description": "The number of Tweets (including Retweets) posted by this User."
}
}
},
"url": {
"type": "string",
"description": "The URL specified in the User's profile."
},
"username": {
"type": "string",
"description": "The Twitter handle (screen name) of this user."
},
"verified": {
"type": "boolean",
"description": "Indicate if this User is a verified Twitter User."
},
"verified_type": {
"type": "string",
"description": "The Twitter Blue verified type of the user, eg: blue, government, business or none."
},
"withheld": {
"type": "object",
"description": "Indicates withholding details for [withheld content](https://help.twitter.com/en/rules-and-policies/tweet-withheld-by-country).",
"required": [
"country_codes"
],
"properties": {
"country_codes": {
"type": "array",
"description": "Provides a list of countries where this content is not available.",
"items": {
"type": "string",
"description": "A two-letter ISO 3166-1 alpha-2 country code."
}
},
"scope": {
"type": "string",
"description": "Indicates that the content being withheld is a `user`.",
"enum": [
"user"
]
}
}
}
}
}
},
"errors": {
"type": "array",
"items": {
"type": "object",
"description": "An HTTP Problem Details object, as defined in IETF RFC 7807 (https://tools.ietf.org/html/rfc7807).",
"required": [
"type",
"title"
],
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "integer"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
}
}
},
"includes": {
"type": "object",
"properties": {
"media": {
"type": "array",
"items": {
"type": "object",
"required": [
"type"
],
"properties": {
"height": {
"type": "integer",
"description": "The height of the media in pixels."
},
"media_key": {
"type": "string",
"description": "The Media Key identifier for this attachment."
},
"type": {
"type": "string"
},
"width": {
"type": "integer",
"description": "The width of the media in pixels."
}
}
}
},
"places": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"full_name"
],
"properties": {
"contained_within": {
"type": "array",
"items": {
"type": "string",
"description": "The identifier for this place."
}
},
"country": {
"type": "string",
"description": "The full name of the county in which this place exists."
},
"country_code": {
"type": "string",
"description": "A two-letter ISO 3166-1 alpha-2 country code."
},
"full_name": {
"type": "string",
"description": "The full name of this place."
},
"geo": {
"type": "object",
"required": [
"type",
"bbox",
"properties"
],
"properties": {
"bbox": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"geometry": {
"type": "object",
"description": "A [GeoJson Point](https://tools.ietf.org/html/rfc7946#section-3.1.2) geometry object.",
"required": [
"type",
"coordinates"
],
"properties": {
"coordinates": {
"type": "array",
"description": "A [GeoJson Position](https://tools.ietf.org/html/rfc7946#section-3.1.1) in the format `[longitude,latitude]`.",
"items": {
"type": "number"
}
},
"type": {
"type": "string",
"enum": [
"Point"
]
}
}
},
"properties": {
"type": "object"
},
"type": {
"type": "string",
"enum": [
"Feature"
]
}
}
},
"id": {
"type": "string",
"description": "The identifier for this place."
},
"name": {
"type": "string",
"description": "The human readable name of this place."
},
"place_type": {
"type": "string",
"enum": [
"poi",
"neighborhood",
"city",
"admin",
"country",
"unknown"
]
}
}
}
},
"polls": {
"type": "array",
"items": {
"type": "object",
"description": "Represent a Poll attached to a Tweet.",
"required": [
"id",
"options"
],
"properties": {
"duration_minutes": {
"type": "integer",
"format": "int32"
},
"end_datetime": {
"type": "string",
"format": "date-time"
},
"id": {
"type": "string",
"description": "Unique identifier of this poll."
},
"options": {
"type": "array",
"items": {
"type": "object",
"description": "Describes a choice in a Poll object.",
"required": [
"position",
"label",
"votes"
],
"properties": {
"label": {
"type": "string",
"description": "The text of a poll choice."
},
"position": {
"type": "integer",
"description": "Position of this choice in the poll."
},
"votes": {
"type": "integer",
"description": "Number of users who voted for this choice."
}
}
}
},
"voting_status": {
"type": "string",
"enum": [
"open",
"closed"
]
}
}
}
},
"topics": {
"type": "array",
"items": {
"type": "object",
"description": "The topic of a Space, as selected by its creator.",
"required": [
"id",
"name"
],
"properties": {
"description": {
"type": "string",
"description": "The description of the given topic."
},
"id": {
"type": "string",
"description": "Unique identifier of this Topic."
},
"name": {
"type": "string",
"description": "The name of the given topic."
}
}
}
},
"tweets": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"text",
"edit_history_tweet_ids"
],
"properties": {
"attachments": {
"type": "object",
"description": "Specifies the type of attachments (if any) present in this Tweet.",
"properties": {
"media_keys": {
"type": "array",
"description": "A list of Media Keys for each one of the media attachments (if media are attached).",
"items": {
"type": "string",
"description": "The Media Key identifier for this attachment."
}
},
"poll_ids": {
"type": "array",
"description": "A list of poll IDs (if polls are attached).",
"items": {
"type": "string",
"description": "Unique identifier of this poll."
}
}
}
},
"author_id": {
"type": "string",
"description": "Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers."
},
"context_annotations": {
"type": "array",
"items": {
"type": "object",
"description": "Annotation inferred from the Tweet text.",
"required": [
"domain",
"entity"
],
"properties": {
"domain": {
"type": "object",
"description": "Represents the data for the context annotation domain.",
"required": [
"id"
],
"properties": {
"description": {
"type": "string",
"description": "Description of the context annotation domain."
},
"id": {
"type": "string",
"description": "The unique id for a context annotation domain."
},
"name": {
"type": "string",
"description": "Name of the context annotation domain."
}
}
},
"entity": {
"type": "object",
"description": "Represents the data for the context annotation entity.",
"required": [
"id"
],
"properties": {
"description": {
"type": "string",
"description": "Description of the context annotation entity."
},
"id": {
"type": "string",
"description": "The unique id for a context annotation entity."
},
"name": {
"type": "string",
"description": "Name of the context annotation entity."
}
}
}
}
}
},
"conversation_id": {
"type": "string",
"description": "Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers."
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Creation time of the Tweet."
},
"edit_controls": {
"type": "object",
"required": [
"is_edit_eligible",
"editable_until",
"edits_remaining"
],
"properties": {
"editable_until": {
"type": "string",
"format": "date-time",
"description": "Time when Tweet is no longer editable."
},
"edits_remaining": {
"type": "integer",
"description": "Number of times this Tweet can be edited."
},
"is_edit_eligible": {
"type": "boolean",
"description": "Indicates if this Tweet is eligible to be edited."
}
}
},
"edit_history_tweet_ids": {
"type": "array",
"description": "A list of Tweet Ids in this Tweet chain.",
"items": {
"type": "string",
"description": "Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers."
}
},
"entities": {
"type": "object",
"properties": {
"annotations": {
"type": "array",
"items": {
"description": "Annotation for entities based on the Tweet text.",
"type": "object"
}
},
"cashtags": {
"type": "array",
"items": {
"type": "object"
}
},
"hashtags": {
"type": "array",
"items": {
"type": "object"
}
},
"mentions": {
"type": "array",
"items": {
"type": "object"
}
},
"urls": {
"type": "array",
"items": {
"description": "Represent the portion of text recognized as a URL, and its start and end position within the text.",
"type": "object"
}
}
}
},
"geo": {
"type": "object",
"description": "The location tagged on the Tweet, if the user provided one.",
"properties": {
"coordinates": {
"type": "object",
"description": "A [GeoJson Point](https://tools.ietf.org/html/rfc7946#section-3.1.2) geometry object.",
"required": [
"type",
"coordinates"
],
"properties": {
"coordinates": {
"type": "array",
"description": "A [GeoJson Position](https://tools.ietf.org/html/rfc7946#section-3.1.1) in the format `[longitude,latitude]`.",
"items": {
"type": "number"
}
},
"type": {
"type": "string",
"enum": [
"Point"
]
}
}
},
"place_id": {
"type": "string",
"description": "The identifier for this place."
}
}
},
"id": {
"type": "string",
"description": "Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers."
},
"in_reply_to_user_id": {
"type": "string",
"description": "Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers."
},
"lang": {
"type": "string",
"description": "Language of the Tweet, if detected by Twitter. Returned as a BCP47 language tag."
},
"non_public_metrics": {
"type": "object",
"description": "Nonpublic engagement metrics for the Tweet at the time of the request.",
"properties": {
"impression_count": {
"type": "integer",
"format": "int32",
"description": "Number of times this Tweet has been viewed."
}
}
},
"organic_metrics": {
"type": "object",
"description": "Organic nonpublic engagement metrics for the Tweet at the time of the request.",
"required": [
"impression_count",
"retweet_count",
"reply_count",
"like_count"
],
"properties": {
"impression_count": {
"type": "integer",
"description": "Number of times this Tweet has been viewed."
},
"like_count": {
"type": "integer",
"description": "Number of times this Tweet has been liked."
},
"reply_count": {
"type": "integer",
"description": "Number of times this Tweet has been replied to."
},
"retweet_count": {
"type": "integer",
"description": "Number of times this Tweet has been Retweeted."
}
}
},
"possibly_sensitive": {
"type": "boolean",
"description": "Indicates if this Tweet contains URLs marked as sensitive, for example content suitable for mature audiences."
},
"promoted_metrics": {
"type": "object",
"description": "Promoted nonpublic engagement metrics for the Tweet at the time of the request.",
"properties": {
"impression_count": {
"type": "integer",
"format": "int32",
"description": "Number of times this Tweet has been viewed."
},
"like_count": {
"type": "integer",
"format": "int32",
"description": "Number of times this Tweet has been liked."
},
"reply_count": {
"type": "integer",
"format": "int32",
"description": "Number of times this Tweet has been replied to."
},
"retweet_count": {
"type": "integer",
"format": "int32",
"description": "Number of times this Tweet has been Retweeted."
}
}
},
"public_metrics": {
"type": "object",
"description": "Engagement metrics for the Tweet at the time of the request.",
"required": [
"retweet_count",
"reply_count",
"like_count",
"impression_count"
],
"properties": {
"impression_count": {
"type": "integer",
"format": "int32",
"description": "Number of times this Tweet has been viewed."
},
"like_count": {
"type": "integer",
"description": "Number of times this Tweet has been liked."
},
"quote_count": {
"type": "integer",
"description": "Number of times this Tweet has been quoted."
},
"reply_count": {
"type": "integer",
"description": "Number of times this Tweet has been replied to."
},
"retweet_count": {
"type": "integer",
"description": "Number of times this Tweet has been Retweeted."
}
}
},
"referenced_tweets": {
"type": "array",
"description": "A list of Tweets this Tweet refers to. For example, if the parent Tweet is a Retweet, a Quoted Tweet or a Reply, it will include the related Tweet referenced to by its parent.",
"items": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers."
},
"type": {
"type": "string",
"enum": [
"retweeted",
"quoted",
"replied_to"
]
}
}
}
},
"reply_settings": {
"type": "string",
"description": "Shows who can reply a Tweet. Fields returned are everyone, mentioned_users, and following.",
"enum": [
"everyone",
"mentionedUsers",
"following",
"other"
]
},
"source": {
"type": "string",
"description": "This is deprecated."
},
"text": {
"type": "string",
"description": "The content of the Tweet."
},
"withheld": {
"type": "object",
"description": "Indicates withholding details for [withheld content](https://help.twitter.com/en/rules-and-policies/tweet-withheld-by-country).",
"required": [
"copyright",
"country_codes"
],
"properties": {
"copyright": {
"type": "boolean",
"description": "Indicates if the content is being withheld for on the basis of copyright infringement."
},
"country_codes": {
"type": "array",
"description": "Provides a list of countries where this content is not available.",
"items": {
"type": "string",
"description": "A two-letter ISO 3166-1 alpha-2 country code."
}
},
"scope": {
"type": "string",
"description": "Indicates whether the content being withheld is the `tweet` or a `user`.",
"enum": [
"tweet",
"user"
]
}
}
}
}
}
},
"users": {
"type": "array",
"items": {
"type": "object",
"description": "The Twitter User object.",
"required": [
"id",
"name",
"username"
],
"properties": {
"created_at": {
"type": "string",
"format": "date-time",
"description": "Creation time of this User."
},
"description": {
"type": "string",
"description": "The text of this User's profile description (also known as bio), if the User provided one."
},
"entities": {
"type": "object",
"description": "A list of metadata found in the User's profile description.",
"properties": {
"description": {
"type": "object",
"properties": {
"annotations": {
"type": "array",
"items": {
"description": "Annotation for entities based on the Tweet text.",
"type": "object"
}
},
"cashtags": {
"type": "array",
"items": {
"type": "object"
}
},
"hashtags": {
"type": "array",
"items": {
"type": "object"
}
},
"mentions": {
"type": "array",
"items": {
"type": "object"
}
},
"urls": {
"type": "array",
"items": {
"description": "Represent the portion of text recognized as a URL, and its start and end position within the text.",
"type": "object"
}
}
}
},
"url": {
"type": "object",
"description": "Expanded details for the URL specified in the User's profile, with start and end indices.",
"properties": {
"urls": {
"type": "array",
"items": {
"description": "Represent the portion of text recognized as a URL, and its start and end position within the text.",
"type": "object"
}
}
}
}
}
},
"id": {
"type": "string",
"description": "Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers."
},
"location": {
"type": "string",
"description": "The location specified in the User's profile, if the User provided one. As this is a freeform value, it may not indicate a valid location, but it may be fuzzily evaluated when performing searches with location queries."
},
"name": {
"type": "string",
"description": "The friendly name of this User, as shown on their profile."
},
"pinned_tweet_id": {
"type": "string",
"description": "Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers."
},
"profile_image_url": {
"type": "string",
"format": "uri",
"description": "The URL to the profile image for this User."
},
"protected": {
"type": "boolean",
"description": "Indicates if this User has chosen to protect their Tweets (in other words, if this User's Tweets are private)."
},
"public_metrics": {
"type": "object",
"description": "A list of metrics for this User.",
"required": [
"followers_count",
"following_count",
"tweet_count",
"listed_count"
],
"properties": {
"followers_count": {
"type": "integer",
"description": "Number of Users who are following this User."
},
"following_count": {
"type": "integer",
"description": "Number of Users this User is following."
},
"listed_count": {
"type": "integer",
"description": "The number of lists that include this User."
},
"tweet_count": {
"type": "integer",
"description": "The number of Tweets (including Retweets) posted by this User."
}
}
},
"url": {
"type": "string",
"description": "The URL specified in the User's profile."
},
"username": {
"type": "string",
"description": "The Twitter handle (screen name) of this user."
},
"verified": {
"type": "boolean",
"description": "Indicate if this User is a verified Twitter User."
},
"verified_type": {
"type": "string",
"description": "The Twitter Blue verified type of the user, eg: blue, government, business or none."
},
"withheld": {
"type": "object",
"description": "Indicates withholding details for [withheld content](https://help.twitter.com/en/rules-and-policies/tweet-withheld-by-country).",
"required": [
"country_codes"
],
"properties": {
"country_codes": {
"type": "array",
"description": "Provides a list of countries where this content is not available.",
"items": {
"type": "string",
"description": "A two-letter ISO 3166-1 alpha-2 country code."
}
},
"scope": {
"type": "string",
"description": "Indicates that the content being withheld is a `user`.",
"enum": [
"user"
]
}
}
}
}
}
}
}
},
"meta": {
"type": "object",
"properties": {
"next_token": {
"type": "string",
"description": "The next token."
},
"previous_token": {
"type": "string",
"description": "The previous token."
},
"result_count": {
"type": "integer",
"format": "int32",
"description": "The number of results returned in this response."
}
}
}
}
}