-
Notifications
You must be signed in to change notification settings - Fork 6
/
schema.graphql
14096 lines (14046 loc) · 764 KB
/
schema.graphql
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
# This file was generated based on ".graphqlconfig". Do not edit manually.
schema {
query: Query
mutation: Mutation
}
"This is the interface implemented by all addresses."
interface AddressInterface {
"Return a number of related elements for a field."
_count(
"The handle of the field that holds the relations."
field: String!
): Int
"First line of the address"
addressLine1: String
"Second line of the address"
addressLine2: String
"Administrative area."
administrativeArea: String
"Whether the element is archived or not."
archived: Boolean
"Two-letter country code"
countryCode: String!
"The date the element was created."
dateCreated: DateTime
"The date the element was last updated."
dateUpdated: DateTime
"Dependent locality"
dependentLocality: String
"Whether the element is enabled or not."
enabled: Boolean
"The first name on the address."
firstName: String
"The full name on the address."
fullName: String
"The ID of the entity"
id: ID
"The language of the site element is associated with."
language: String
"The last name on the address."
lastName: String
"Latitude"
latitude: String
"Locality"
locality: String
"Longitude"
longitude: String
"Organization name"
organization: String
"Organization tax ID"
organizationTaxId: String
"Postal code"
postalCode: String
"The element’s search score, if the `search` parameter was used when querying for the element."
searchScore: Int
"The ID of the site the element is associated with."
siteId: Int
"The unique identifier for an element-site relation."
siteSettingsId: ID
"The element’s slug."
slug: String
"Sorting code"
sortingCode: String
"The element’s status."
status: String
"The element’s title."
title: String
"Whether the element has been soft-deleted or not."
trashed: Boolean
"The UID of the entity"
uid: String
"The element’s URI."
uri: String
}
"This is the interface implemented by all assets."
interface AssetInterface {
"Return a number of related elements for a field."
_count(
"The handle of the field that holds the relations."
field: String!
): Int
"Alternative text for the asset."
alt: String
"Whether the element is archived or not."
archived: Boolean
"The date the element was created."
dateCreated: DateTime
"The date the asset file was last modified."
dateModified: DateTime
"The date the element was last updated."
dateUpdated: DateTime
"Whether the element is enabled or not."
enabled: Boolean
"The file extension for the asset file."
extension: String!
"The filename of the asset file."
filename: String!
"The focal point represented as an array with `x` and `y` keys, or null if it’s not an image."
focalPoint: [Float]
"The ID of the folder that the asset belongs to."
folderId: Int!
"Whether a user-defined focal point is set on the asset."
hasFocalPoint: Boolean!
"The height in pixels or null if it’s not an image."
height(
"The format to use for the transform"
format: String,
"The handle of the named transform to use."
handle: String,
"Height for the generated transform"
height: Int,
"[_Deprecated_] This argument is deprecated and has no effect."
immediately: Boolean,
"The interlace mode to use for the transform"
interlace: String,
"The mode to use for the generated transform."
mode: String,
"The position to use when cropping, if no focal point specified."
position: String,
"The quality of the transform"
quality: Int,
"The handle of the named transform to use."
transform: String,
"Width for the generated transform"
width: Int
): Int
"The ID of the entity"
id: ID
"An `<img>` tag based on this asset."
img: String
"The file kind."
kind: String!
"The language of the site element is associated with."
language: String
"The file’s MIME type, if it can be determined."
mimeType: String
"Returns the next element relative to this one, from a given set of criteria."
next(
"Narrows the query results to only elements that have been archived."
archived: Boolean,
"Narrows the query results based on the elements’ creation dates."
dateCreated: [String],
"Narrows the query results based on the assets’ files’ last-modified dates."
dateModified: String,
"Narrows the query results based on the elements’ last-updated dates."
dateUpdated: [String],
"Narrows the query results based on the assets’ filenames."
filename: [String],
"Causes the query results to be returned in the order specified by the `id` argument."
fixedOrder: Boolean,
"Narrows the query results based on the folders the assets belong to, per the folders’ IDs."
folderId: [QueryArgument],
"Narrows the query results based on whether the assets have alternative text."
hasAlt: Boolean,
"Narrows the query results based on the assets’ image heights."
height: [String],
"Narrows the query results based on the elements’ IDs."
id: [QueryArgument],
"Causes the query results to be returned in reverse order."
inReverse: Boolean,
"Broadens the query results to include assets from any of the subfolders of the folder specified by `folderId`."
includeSubfolders: Boolean,
"Narrows the query results based on the assets’ file kinds."
kind: [String],
"Sets the limit for paginated results."
limit: Int,
"Sets the offset for paginated results."
offset: Int,
"Sets the field the returned elements should be ordered by."
orderBy: String,
"Determines which site should be selected when querying multi-site elements."
preferSites: [QueryArgument],
"Narrows the query results based on a reference string."
ref: [String],
"Narrows the query results to elements that relate to the provided element IDs. This argument is ignored, if `relatedToAll` is also used."
relatedTo: [QueryArgument],
"Narrows the query results to elements that relate to *all* of the provided element IDs. Using this argument will cause `relatedTo` argument to be ignored. **This argument is deprecated.** `relatedTo: [\"and\", ...ids]` should be used instead."
relatedToAll: [QueryArgument],
"Narrows the query results to elements that relate to an asset list defined with this argument."
relatedToAssets: [AssetCriteriaInput],
"Narrows the query results to elements that relate to a category list defined with this argument."
relatedToCategories: [CategoryCriteriaInput],
"Narrows the query results to elements that relate to an entry list defined with this argument."
relatedToEntries: [EntryCriteriaInput],
"Narrows the query results to elements that relate to a tag list defined with this argument."
relatedToTags: [TagCriteriaInput],
"Narrows the query results to elements that relate to a use list defined with this argument."
relatedToUsers: [UserCriteriaInput],
"Narrows the query results to only elements that match a search query."
search: String,
"Determines which site(s) the elements should be queried in. Defaults to the current (requested) site."
site: [String],
"Determines which site(s) the elements should be queried in. Defaults to the current (requested) site."
siteId: [QueryArgument],
"Narrows the query results based on the unique identifier for an element-site relation."
siteSettingsId: [QueryArgument],
"Narrows the query results based on the assets’ file sizes (in bytes)."
size: [String],
"Narrows the query results based on the elements’ slugs."
slug: [String],
"Narrows the query results based on the elements’ statuses."
status: [String],
"Narrows the query results based on the elements’ titles."
title: [String],
"Narrows the query results to only elements that have been soft-deleted."
trashed: Boolean,
"Narrows the query results based on the elements’ UIDs."
uid: [String],
"Determines whether only elements with unique IDs should be returned by the query."
unique: Boolean,
"Narrows the query results based on the user the assets were uploaded by, per the user’s ID."
uploader: QueryArgument,
"Narrows the query results based on the elements’ URIs."
uri: [String],
"Narrows the query results based on the volumes the assets belong to, per the volumes’ handles."
volume: [String],
"Narrows the query results based on the volumes the assets belong to, per the volumes’ IDs."
volumeId: [QueryArgument],
"Narrows the query results based on the assets’ image widths."
width: [String],
"A list of transform handles to preload."
withTransforms: [String]
): AssetInterface
"The asset’s path in the volume."
path: String!
"Returns the previous element relative to this one, from a given set of criteria."
prev(
"Narrows the query results to only elements that have been archived."
archived: Boolean,
"Narrows the query results based on the elements’ creation dates."
dateCreated: [String],
"Narrows the query results based on the assets’ files’ last-modified dates."
dateModified: String,
"Narrows the query results based on the elements’ last-updated dates."
dateUpdated: [String],
"Narrows the query results based on the assets’ filenames."
filename: [String],
"Causes the query results to be returned in the order specified by the `id` argument."
fixedOrder: Boolean,
"Narrows the query results based on the folders the assets belong to, per the folders’ IDs."
folderId: [QueryArgument],
"Narrows the query results based on whether the assets have alternative text."
hasAlt: Boolean,
"Narrows the query results based on the assets’ image heights."
height: [String],
"Narrows the query results based on the elements’ IDs."
id: [QueryArgument],
"Causes the query results to be returned in reverse order."
inReverse: Boolean,
"Broadens the query results to include assets from any of the subfolders of the folder specified by `folderId`."
includeSubfolders: Boolean,
"Narrows the query results based on the assets’ file kinds."
kind: [String],
"Sets the limit for paginated results."
limit: Int,
"Sets the offset for paginated results."
offset: Int,
"Sets the field the returned elements should be ordered by."
orderBy: String,
"Determines which site should be selected when querying multi-site elements."
preferSites: [QueryArgument],
"Narrows the query results based on a reference string."
ref: [String],
"Narrows the query results to elements that relate to the provided element IDs. This argument is ignored, if `relatedToAll` is also used."
relatedTo: [QueryArgument],
"Narrows the query results to elements that relate to *all* of the provided element IDs. Using this argument will cause `relatedTo` argument to be ignored. **This argument is deprecated.** `relatedTo: [\"and\", ...ids]` should be used instead."
relatedToAll: [QueryArgument],
"Narrows the query results to elements that relate to an asset list defined with this argument."
relatedToAssets: [AssetCriteriaInput],
"Narrows the query results to elements that relate to a category list defined with this argument."
relatedToCategories: [CategoryCriteriaInput],
"Narrows the query results to elements that relate to an entry list defined with this argument."
relatedToEntries: [EntryCriteriaInput],
"Narrows the query results to elements that relate to a tag list defined with this argument."
relatedToTags: [TagCriteriaInput],
"Narrows the query results to elements that relate to a use list defined with this argument."
relatedToUsers: [UserCriteriaInput],
"Narrows the query results to only elements that match a search query."
search: String,
"Determines which site(s) the elements should be queried in. Defaults to the current (requested) site."
site: [String],
"Determines which site(s) the elements should be queried in. Defaults to the current (requested) site."
siteId: [QueryArgument],
"Narrows the query results based on the unique identifier for an element-site relation."
siteSettingsId: [QueryArgument],
"Narrows the query results based on the assets’ file sizes (in bytes)."
size: [String],
"Narrows the query results based on the elements’ slugs."
slug: [String],
"Narrows the query results based on the elements’ statuses."
status: [String],
"Narrows the query results based on the elements’ titles."
title: [String],
"Narrows the query results to only elements that have been soft-deleted."
trashed: Boolean,
"Narrows the query results based on the elements’ UIDs."
uid: [String],
"Determines whether only elements with unique IDs should be returned by the query."
unique: Boolean,
"Narrows the query results based on the user the assets were uploaded by, per the user’s ID."
uploader: QueryArgument,
"Narrows the query results based on the elements’ URIs."
uri: [String],
"Narrows the query results based on the volumes the assets belong to, per the volumes’ handles."
volume: [String],
"Narrows the query results based on the volumes the assets belong to, per the volumes’ IDs."
volumeId: [QueryArgument],
"Narrows the query results based on the assets’ image widths."
width: [String],
"A list of transform handles to preload."
withTransforms: [String]
): AssetInterface
"The element’s search score, if the `search` parameter was used when querying for the element."
searchScore: Int
"The ID of the site the element is associated with."
siteId: Int
"The unique identifier for an element-site relation."
siteSettingsId: ID
"The file size in bytes."
size: String
"The element’s slug."
slug: String
"Returns a `srcset` attribute value based on the given widths or x-descriptors."
srcset(
"A list of size descriptors. If you pass x-descriptors, it will be assumed that the image’s current width is the intended 1x width."
sizes: [String!]!
): String
"The element’s status."
status: String
"The element’s title."
title: String
"Whether the element has been soft-deleted or not."
trashed: Boolean
"The UID of the entity"
uid: String
"The user who first added this asset (if known)."
uploader(
"Narrows the query results to only elements that have been archived."
archived: Boolean,
"Narrows the query results based on whether the users have uploaded any assets."
assetUploaders: Boolean,
"Narrows the query results based on whether the users are listed as the author of any entries."
authors: Boolean,
"Narrows the query results based on the elements’ creation dates."
dateCreated: [String],
"Narrows the query results based on the elements’ last-updated dates."
dateUpdated: [String],
"Narrows the query results based on the users’ email addresses."
email: [String],
"Narrows the query results based on the users’ first names."
firstName: [String],
"Causes the query results to be returned in the order specified by the `id` argument."
fixedOrder: Boolean,
"Narrows the query results based on the users’ full names."
fullName: [String],
"Narrows the query results based on the user group the users belong to."
group: [QueryArgument],
"Narrows the query results based on the user group the users belong to, per the groups’ IDs."
groupId: [QueryArgument],
"Narrows the query results to only users that have (or don’t have) a user photo."
hasPhoto: Boolean,
"Narrows the query results based on the elements’ IDs."
id: [QueryArgument],
"Causes the query results to be returned in reverse order."
inReverse: Boolean,
"Narrows the query results based on the users’ last names."
lastName: [String],
"Sets the limit for paginated results."
limit: Int,
"Sets the offset for paginated results."
offset: Int,
"Sets the field the returned elements should be ordered by."
orderBy: String,
"Determines which site should be selected when querying multi-site elements."
preferSites: [QueryArgument],
"Narrows the query results based on a reference string."
ref: [String],
"Narrows the query results to elements that relate to the provided element IDs. This argument is ignored, if `relatedToAll` is also used."
relatedTo: [QueryArgument],
"Narrows the query results to elements that relate to *all* of the provided element IDs. Using this argument will cause `relatedTo` argument to be ignored. **This argument is deprecated.** `relatedTo: [\"and\", ...ids]` should be used instead."
relatedToAll: [QueryArgument],
"Narrows the query results to elements that relate to an asset list defined with this argument."
relatedToAssets: [AssetCriteriaInput],
"Narrows the query results to elements that relate to a category list defined with this argument."
relatedToCategories: [CategoryCriteriaInput],
"Narrows the query results to elements that relate to an entry list defined with this argument."
relatedToEntries: [EntryCriteriaInput],
"Narrows the query results to elements that relate to a tag list defined with this argument."
relatedToTags: [TagCriteriaInput],
"Narrows the query results to elements that relate to a use list defined with this argument."
relatedToUsers: [UserCriteriaInput],
"Narrows the query results to only elements that match a search query."
search: String,
"Determines which site(s) the elements should be queried in. Defaults to the current (requested) site."
site: [String],
"Determines which site(s) the elements should be queried in. Defaults to the current (requested) site."
siteId: [QueryArgument],
"Narrows the query results based on the unique identifier for an element-site relation."
siteSettingsId: [QueryArgument],
"Narrows the query results based on the elements’ slugs."
slug: [String],
"Narrows the query results based on the elements’ statuses."
status: [String],
"Narrows the query results based on the elements’ titles."
title: [String],
"Narrows the query results to only elements that have been soft-deleted."
trashed: Boolean,
"Narrows the query results based on the elements’ UIDs."
uid: [String],
"Determines whether only elements with unique IDs should be returned by the query."
unique: Boolean,
"Narrows the query results based on the elements’ URIs."
uri: [String],
"Narrows the query results based on the users’ usernames."
username: [String]
): UserInterface
"The ID of the user who first added this asset (if known)."
uploaderId: Int
"The element’s URI."
uri: String
"The full URL of the asset. This field accepts the same fields as the `transform` directive."
url(
"The format to use for the transform"
format: String,
"The handle of the named transform to use."
handle: String,
"Height for the generated transform"
height: Int,
"[_Deprecated_] This argument is deprecated and has no effect."
immediately: Boolean,
"The interlace mode to use for the transform"
interlace: String,
"The mode to use for the generated transform."
mode: String,
"The position to use when cropping, if no focal point specified."
position: String,
"The quality of the transform"
quality: Int,
"The handle of the named transform to use."
transform: String,
"Width for the generated transform"
width: Int
): String
"The ID of the volume that the asset belongs to."
volumeId: Int
"The width in pixels or null if it’s not an image."
width(
"The format to use for the transform"
format: String,
"The handle of the named transform to use."
handle: String,
"Height for the generated transform"
height: Int,
"[_Deprecated_] This argument is deprecated and has no effect."
immediately: Boolean,
"The interlace mode to use for the transform"
interlace: String,
"The mode to use for the generated transform."
mode: String,
"The position to use when cropping, if no focal point specified."
position: String,
"The quality of the transform"
quality: Int,
"The handle of the named transform to use."
transform: String,
"Width for the generated transform"
width: Int
): Int
}
"This is the interface implemented by all categories."
interface CategoryInterface {
"Return a number of related elements for a field."
_count(
"The handle of the field that holds the relations."
field: String!
): Int
"Whether the element is archived or not."
archived: Boolean
"The category’s children."
children(
"Narrows the query results to only elements that are up to a certain distance away from the element in its structure specified by `ancestorOf`."
ancestorDist: Int,
"Narrows the query results to only elements that are ancestors of another element in its structure, provided by its ID."
ancestorOf: Int,
"Narrows the query results to only elements that have been archived."
archived: Boolean,
"Narrows the query results based on the elements’ creation dates."
dateCreated: [String],
"Narrows the query results based on the elements’ last-updated dates."
dateUpdated: [String],
"Narrows the query results to only elements that are up to a certain distance away from the element in its structure specified by `descendantOf`."
descendantDist: Int,
"Narrows the query results to only elements that are descendants of another element in its structure provided by its ID."
descendantOf: Int,
"Whether to only return categories that the user has permission to edit."
editable: Boolean,
"Causes the query results to be returned in the order specified by the `id` argument."
fixedOrder: Boolean,
"Narrows the query results based on the category groups the categories belong to per the group’s handles."
group: [String],
"Narrows the query results based on the category groups the categories belong to, per the groups’ IDs."
groupId: [QueryArgument],
"Narrows the query results based on whether the elements have any descendants in their structure."
hasDescendants: Boolean,
"Narrows the query results based on the elements’ IDs."
id: [QueryArgument],
"Causes the query results to be returned in reverse order."
inReverse: Boolean,
"Narrows the query results based on whether the elements are “leaves” in their structure (element with no descendants)."
leaves: Boolean,
"Narrows the query results based on the elements’ level within the structure."
level: Int,
"Sets the limit for paginated results."
limit: Int,
"Narrows the query results to only the entry that comes immediately after another element in its structure, provided by its ID."
nextSiblingOf: Int,
"Sets the offset for paginated results."
offset: Int,
"Sets the field the returned elements should be ordered by."
orderBy: String,
"Narrows the query results to only entries that are positioned after another element in its structure, provided by its ID."
positionedAfter: Int,
"Narrows the query results to only entries that are positioned before another element in its structure, provided by its ID."
positionedBefore: Int,
"Determines which site should be selected when querying multi-site elements."
preferSites: [QueryArgument],
"Narrows the query results to only the entry that comes immediately before another element in its structure, provided by its ID."
prevSiblingOf: Int,
"Narrows the query results based on a reference string."
ref: [String],
"Narrows the query results to elements that relate to the provided element IDs. This argument is ignored, if `relatedToAll` is also used."
relatedTo: [QueryArgument],
"Narrows the query results to elements that relate to *all* of the provided element IDs. Using this argument will cause `relatedTo` argument to be ignored. **This argument is deprecated.** `relatedTo: [\"and\", ...ids]` should be used instead."
relatedToAll: [QueryArgument],
"Narrows the query results to elements that relate to an asset list defined with this argument."
relatedToAssets: [AssetCriteriaInput],
"Narrows the query results to elements that relate to a category list defined with this argument."
relatedToCategories: [CategoryCriteriaInput],
"Narrows the query results to elements that relate to an entry list defined with this argument."
relatedToEntries: [EntryCriteriaInput],
"Narrows the query results to elements that relate to a tag list defined with this argument."
relatedToTags: [TagCriteriaInput],
"Narrows the query results to elements that relate to a use list defined with this argument."
relatedToUsers: [UserCriteriaInput],
"Narrows the query results to only elements that match a search query."
search: String,
"Determines which site(s) the elements should be queried in. Defaults to the current (requested) site."
site: [String],
"Determines which site(s) the elements should be queried in. Defaults to the current (requested) site."
siteId: [QueryArgument],
"Narrows the query results based on the unique identifier for an element-site relation."
siteSettingsId: [QueryArgument],
"Narrows the query results based on the elements’ slugs."
slug: [String],
"Narrows the query results based on the elements’ statuses."
status: [String],
"Determines which structure data should be joined into the query."
structureId: Int,
"Narrows the query results based on the elements’ titles."
title: [String],
"Narrows the query results to only elements that have been soft-deleted."
trashed: Boolean,
"Narrows the query results based on the elements’ UIDs."
uid: [String],
"Determines whether only elements with unique IDs should be returned by the query."
unique: Boolean,
"Narrows the query results based on the elements’ URIs."
uri: [String],
"Explicitly determines whether the query should join in the structure data."
withStructure: Boolean
): [CategoryInterface!]!
"The date the element was created."
dateCreated: DateTime
"The date the element was last updated."
dateUpdated: DateTime
"Whether the element is enabled or not."
enabled: Boolean
"The handle of the group that contains the category."
groupHandle: String!
"The ID of the group that contains the category."
groupId: Int!
"The ID of the entity"
id: ID
"The language of the site element is associated with."
language: String
"The element’s level within its structure"
level: Int
"The element’s left position within its structure."
lft: Int
"The same element in other locales."
localized(
"Narrows the query results to only elements that are up to a certain distance away from the element in its structure specified by `ancestorOf`."
ancestorDist: Int,
"Narrows the query results to only elements that are ancestors of another element in its structure, provided by its ID."
ancestorOf: Int,
"Narrows the query results to only elements that have been archived."
archived: Boolean,
"Narrows the query results based on the elements’ creation dates."
dateCreated: [String],
"Narrows the query results based on the elements’ last-updated dates."
dateUpdated: [String],
"Narrows the query results to only elements that are up to a certain distance away from the element in its structure specified by `descendantOf`."
descendantDist: Int,
"Narrows the query results to only elements that are descendants of another element in its structure provided by its ID."
descendantOf: Int,
"Whether to only return categories that the user has permission to edit."
editable: Boolean,
"Causes the query results to be returned in the order specified by the `id` argument."
fixedOrder: Boolean,
"Narrows the query results based on the category groups the categories belong to per the group’s handles."
group: [String],
"Narrows the query results based on the category groups the categories belong to, per the groups’ IDs."
groupId: [QueryArgument],
"Narrows the query results based on whether the elements have any descendants in their structure."
hasDescendants: Boolean,
"Narrows the query results based on the elements’ IDs."
id: [QueryArgument],
"Causes the query results to be returned in reverse order."
inReverse: Boolean,
"Narrows the query results based on whether the elements are “leaves” in their structure (element with no descendants)."
leaves: Boolean,
"Narrows the query results based on the elements’ level within the structure."
level: Int,
"Sets the limit for paginated results."
limit: Int,
"Narrows the query results to only the entry that comes immediately after another element in its structure, provided by its ID."
nextSiblingOf: Int,
"Sets the offset for paginated results."
offset: Int,
"Sets the field the returned elements should be ordered by."
orderBy: String,
"Narrows the query results to only entries that are positioned after another element in its structure, provided by its ID."
positionedAfter: Int,
"Narrows the query results to only entries that are positioned before another element in its structure, provided by its ID."
positionedBefore: Int,
"Determines which site should be selected when querying multi-site elements."
preferSites: [QueryArgument],
"Narrows the query results to only the entry that comes immediately before another element in its structure, provided by its ID."
prevSiblingOf: Int,
"Narrows the query results based on a reference string."
ref: [String],
"Narrows the query results to elements that relate to the provided element IDs. This argument is ignored, if `relatedToAll` is also used."
relatedTo: [QueryArgument],
"Narrows the query results to elements that relate to *all* of the provided element IDs. Using this argument will cause `relatedTo` argument to be ignored. **This argument is deprecated.** `relatedTo: [\"and\", ...ids]` should be used instead."
relatedToAll: [QueryArgument],
"Narrows the query results to elements that relate to an asset list defined with this argument."
relatedToAssets: [AssetCriteriaInput],
"Narrows the query results to elements that relate to a category list defined with this argument."
relatedToCategories: [CategoryCriteriaInput],
"Narrows the query results to elements that relate to an entry list defined with this argument."
relatedToEntries: [EntryCriteriaInput],
"Narrows the query results to elements that relate to a tag list defined with this argument."
relatedToTags: [TagCriteriaInput],
"Narrows the query results to elements that relate to a use list defined with this argument."
relatedToUsers: [UserCriteriaInput],
"Narrows the query results to only elements that match a search query."
search: String,
"Determines which site(s) the elements should be queried in. Defaults to the current (requested) site."
site: [String],
"Determines which site(s) the elements should be queried in. Defaults to the current (requested) site."
siteId: [QueryArgument],
"Narrows the query results based on the unique identifier for an element-site relation."
siteSettingsId: [QueryArgument],
"Narrows the query results based on the elements’ slugs."
slug: [String],
"Narrows the query results based on the elements’ statuses."
status: [String],
"Determines which structure data should be joined into the query."
structureId: Int,
"Narrows the query results based on the elements’ titles."
title: [String],
"Narrows the query results to only elements that have been soft-deleted."
trashed: Boolean,
"Narrows the query results based on the elements’ UIDs."
uid: [String],
"Determines whether only elements with unique IDs should be returned by the query."
unique: Boolean,
"Narrows the query results based on the elements’ URIs."
uri: [String],
"Explicitly determines whether the query should join in the structure data."
withStructure: Boolean
): [CategoryInterface!]!
"Returns the next element relative to this one, from a given set of criteria."
next(
"Narrows the query results to only elements that are up to a certain distance away from the element in its structure specified by `ancestorOf`."
ancestorDist: Int,
"Narrows the query results to only elements that are ancestors of another element in its structure, provided by its ID."
ancestorOf: Int,
"Narrows the query results to only elements that have been archived."
archived: Boolean,
"Narrows the query results based on the elements’ creation dates."
dateCreated: [String],
"Narrows the query results based on the elements’ last-updated dates."
dateUpdated: [String],
"Narrows the query results to only elements that are up to a certain distance away from the element in its structure specified by `descendantOf`."
descendantDist: Int,
"Narrows the query results to only elements that are descendants of another element in its structure provided by its ID."
descendantOf: Int,
"Whether to only return categories that the user has permission to edit."
editable: Boolean,
"Causes the query results to be returned in the order specified by the `id` argument."
fixedOrder: Boolean,
"Narrows the query results based on the category groups the categories belong to per the group’s handles."
group: [String],
"Narrows the query results based on the category groups the categories belong to, per the groups’ IDs."
groupId: [QueryArgument],
"Narrows the query results based on whether the elements have any descendants in their structure."
hasDescendants: Boolean,
"Narrows the query results based on the elements’ IDs."
id: [QueryArgument],
"Causes the query results to be returned in reverse order."
inReverse: Boolean,
"Narrows the query results based on whether the elements are “leaves” in their structure (element with no descendants)."
leaves: Boolean,
"Narrows the query results based on the elements’ level within the structure."
level: Int,
"Sets the limit for paginated results."
limit: Int,
"Narrows the query results to only the entry that comes immediately after another element in its structure, provided by its ID."
nextSiblingOf: Int,
"Sets the offset for paginated results."
offset: Int,
"Sets the field the returned elements should be ordered by."
orderBy: String,
"Narrows the query results to only entries that are positioned after another element in its structure, provided by its ID."
positionedAfter: Int,
"Narrows the query results to only entries that are positioned before another element in its structure, provided by its ID."
positionedBefore: Int,
"Determines which site should be selected when querying multi-site elements."
preferSites: [QueryArgument],
"Narrows the query results to only the entry that comes immediately before another element in its structure, provided by its ID."
prevSiblingOf: Int,
"Narrows the query results based on a reference string."
ref: [String],
"Narrows the query results to elements that relate to the provided element IDs. This argument is ignored, if `relatedToAll` is also used."
relatedTo: [QueryArgument],
"Narrows the query results to elements that relate to *all* of the provided element IDs. Using this argument will cause `relatedTo` argument to be ignored. **This argument is deprecated.** `relatedTo: [\"and\", ...ids]` should be used instead."
relatedToAll: [QueryArgument],
"Narrows the query results to elements that relate to an asset list defined with this argument."
relatedToAssets: [AssetCriteriaInput],
"Narrows the query results to elements that relate to a category list defined with this argument."
relatedToCategories: [CategoryCriteriaInput],
"Narrows the query results to elements that relate to an entry list defined with this argument."
relatedToEntries: [EntryCriteriaInput],
"Narrows the query results to elements that relate to a tag list defined with this argument."
relatedToTags: [TagCriteriaInput],
"Narrows the query results to elements that relate to a use list defined with this argument."
relatedToUsers: [UserCriteriaInput],
"Narrows the query results to only elements that match a search query."
search: String,
"Determines which site(s) the elements should be queried in. Defaults to the current (requested) site."
site: [String],
"Determines which site(s) the elements should be queried in. Defaults to the current (requested) site."
siteId: [QueryArgument],
"Narrows the query results based on the unique identifier for an element-site relation."
siteSettingsId: [QueryArgument],
"Narrows the query results based on the elements’ slugs."
slug: [String],
"Narrows the query results based on the elements’ statuses."
status: [String],
"Determines which structure data should be joined into the query."
structureId: Int,
"Narrows the query results based on the elements’ titles."
title: [String],
"Narrows the query results to only elements that have been soft-deleted."
trashed: Boolean,
"Narrows the query results based on the elements’ UIDs."
uid: [String],
"Determines whether only elements with unique IDs should be returned by the query."
unique: Boolean,
"Narrows the query results based on the elements’ URIs."
uri: [String],
"Explicitly determines whether the query should join in the structure data."
withStructure: Boolean
): CategoryInterface
"The category’s parent."
parent(
"Narrows the query results to only elements that are up to a certain distance away from the element in its structure specified by `ancestorOf`."
ancestorDist: Int,
"Narrows the query results to only elements that are ancestors of another element in its structure, provided by its ID."
ancestorOf: Int,
"Narrows the query results to only elements that have been archived."
archived: Boolean,
"Narrows the query results based on the elements’ creation dates."
dateCreated: [String],
"Narrows the query results based on the elements’ last-updated dates."
dateUpdated: [String],
"Narrows the query results to only elements that are up to a certain distance away from the element in its structure specified by `descendantOf`."
descendantDist: Int,
"Narrows the query results to only elements that are descendants of another element in its structure provided by its ID."
descendantOf: Int,
"Whether to only return categories that the user has permission to edit."
editable: Boolean,
"Causes the query results to be returned in the order specified by the `id` argument."
fixedOrder: Boolean,
"Narrows the query results based on the category groups the categories belong to per the group’s handles."
group: [String],
"Narrows the query results based on the category groups the categories belong to, per the groups’ IDs."
groupId: [QueryArgument],
"Narrows the query results based on whether the elements have any descendants in their structure."
hasDescendants: Boolean,
"Narrows the query results based on the elements’ IDs."
id: [QueryArgument],
"Causes the query results to be returned in reverse order."
inReverse: Boolean,
"Narrows the query results based on whether the elements are “leaves” in their structure (element with no descendants)."
leaves: Boolean,
"Narrows the query results based on the elements’ level within the structure."
level: Int,
"Sets the limit for paginated results."
limit: Int,
"Narrows the query results to only the entry that comes immediately after another element in its structure, provided by its ID."
nextSiblingOf: Int,
"Sets the offset for paginated results."
offset: Int,
"Sets the field the returned elements should be ordered by."
orderBy: String,
"Narrows the query results to only entries that are positioned after another element in its structure, provided by its ID."
positionedAfter: Int,
"Narrows the query results to only entries that are positioned before another element in its structure, provided by its ID."
positionedBefore: Int,
"Determines which site should be selected when querying multi-site elements."
preferSites: [QueryArgument],
"Narrows the query results to only the entry that comes immediately before another element in its structure, provided by its ID."
prevSiblingOf: Int,
"Narrows the query results based on a reference string."
ref: [String],
"Narrows the query results to elements that relate to the provided element IDs. This argument is ignored, if `relatedToAll` is also used."
relatedTo: [QueryArgument],
"Narrows the query results to elements that relate to *all* of the provided element IDs. Using this argument will cause `relatedTo` argument to be ignored. **This argument is deprecated.** `relatedTo: [\"and\", ...ids]` should be used instead."
relatedToAll: [QueryArgument],
"Narrows the query results to elements that relate to an asset list defined with this argument."
relatedToAssets: [AssetCriteriaInput],
"Narrows the query results to elements that relate to a category list defined with this argument."
relatedToCategories: [CategoryCriteriaInput],
"Narrows the query results to elements that relate to an entry list defined with this argument."
relatedToEntries: [EntryCriteriaInput],
"Narrows the query results to elements that relate to a tag list defined with this argument."
relatedToTags: [TagCriteriaInput],
"Narrows the query results to elements that relate to a use list defined with this argument."
relatedToUsers: [UserCriteriaInput],
"Narrows the query results to only elements that match a search query."
search: String,
"Determines which site(s) the elements should be queried in. Defaults to the current (requested) site."
site: [String],
"Determines which site(s) the elements should be queried in. Defaults to the current (requested) site."
siteId: [QueryArgument],
"Narrows the query results based on the unique identifier for an element-site relation."
siteSettingsId: [QueryArgument],
"Narrows the query results based on the elements’ slugs."
slug: [String],
"Narrows the query results based on the elements’ statuses."
status: [String],
"Determines which structure data should be joined into the query."
structureId: Int,
"Narrows the query results based on the elements’ titles."
title: [String],
"Narrows the query results to only elements that have been soft-deleted."
trashed: Boolean,
"Narrows the query results based on the elements’ UIDs."
uid: [String],
"Determines whether only elements with unique IDs should be returned by the query."
unique: Boolean,
"Narrows the query results based on the elements’ URIs."
uri: [String],
"Explicitly determines whether the query should join in the structure data."
withStructure: Boolean
): CategoryInterface
"Returns the previous element relative to this one, from a given set of criteria."
prev(
"Narrows the query results to only elements that are up to a certain distance away from the element in its structure specified by `ancestorOf`."
ancestorDist: Int,
"Narrows the query results to only elements that are ancestors of another element in its structure, provided by its ID."
ancestorOf: Int,
"Narrows the query results to only elements that have been archived."
archived: Boolean,
"Narrows the query results based on the elements’ creation dates."
dateCreated: [String],
"Narrows the query results based on the elements’ last-updated dates."
dateUpdated: [String],
"Narrows the query results to only elements that are up to a certain distance away from the element in its structure specified by `descendantOf`."
descendantDist: Int,
"Narrows the query results to only elements that are descendants of another element in its structure provided by its ID."
descendantOf: Int,
"Whether to only return categories that the user has permission to edit."
editable: Boolean,
"Causes the query results to be returned in the order specified by the `id` argument."
fixedOrder: Boolean,
"Narrows the query results based on the category groups the categories belong to per the group’s handles."
group: [String],
"Narrows the query results based on the category groups the categories belong to, per the groups’ IDs."
groupId: [QueryArgument],
"Narrows the query results based on whether the elements have any descendants in their structure."
hasDescendants: Boolean,
"Narrows the query results based on the elements’ IDs."
id: [QueryArgument],
"Causes the query results to be returned in reverse order."
inReverse: Boolean,
"Narrows the query results based on whether the elements are “leaves” in their structure (element with no descendants)."
leaves: Boolean,
"Narrows the query results based on the elements’ level within the structure."
level: Int,
"Sets the limit for paginated results."
limit: Int,
"Narrows the query results to only the entry that comes immediately after another element in its structure, provided by its ID."
nextSiblingOf: Int,
"Sets the offset for paginated results."
offset: Int,
"Sets the field the returned elements should be ordered by."
orderBy: String,
"Narrows the query results to only entries that are positioned after another element in its structure, provided by its ID."
positionedAfter: Int,
"Narrows the query results to only entries that are positioned before another element in its structure, provided by its ID."
positionedBefore: Int,
"Determines which site should be selected when querying multi-site elements."
preferSites: [QueryArgument],
"Narrows the query results to only the entry that comes immediately before another element in its structure, provided by its ID."
prevSiblingOf: Int,
"Narrows the query results based on a reference string."
ref: [String],
"Narrows the query results to elements that relate to the provided element IDs. This argument is ignored, if `relatedToAll` is also used."
relatedTo: [QueryArgument],
"Narrows the query results to elements that relate to *all* of the provided element IDs. Using this argument will cause `relatedTo` argument to be ignored. **This argument is deprecated.** `relatedTo: [\"and\", ...ids]` should be used instead."
relatedToAll: [QueryArgument],
"Narrows the query results to elements that relate to an asset list defined with this argument."
relatedToAssets: [AssetCriteriaInput],
"Narrows the query results to elements that relate to a category list defined with this argument."
relatedToCategories: [CategoryCriteriaInput],
"Narrows the query results to elements that relate to an entry list defined with this argument."
relatedToEntries: [EntryCriteriaInput],
"Narrows the query results to elements that relate to a tag list defined with this argument."
relatedToTags: [TagCriteriaInput],
"Narrows the query results to elements that relate to a use list defined with this argument."
relatedToUsers: [UserCriteriaInput],
"Narrows the query results to only elements that match a search query."
search: String,
"Determines which site(s) the elements should be queried in. Defaults to the current (requested) site."
site: [String],
"Determines which site(s) the elements should be queried in. Defaults to the current (requested) site."
siteId: [QueryArgument],
"Narrows the query results based on the unique identifier for an element-site relation."
siteSettingsId: [QueryArgument],
"Narrows the query results based on the elements’ slugs."
slug: [String],
"Narrows the query results based on the elements’ statuses."
status: [String],
"Determines which structure data should be joined into the query."
structureId: Int,
"Narrows the query results based on the elements’ titles."
title: [String],
"Narrows the query results to only elements that have been soft-deleted."
trashed: Boolean,
"Narrows the query results based on the elements’ UIDs."
uid: [String],
"Determines whether only elements with unique IDs should be returned by the query."
unique: Boolean,
"Narrows the query results based on the elements’ URIs."
uri: [String],
"Explicitly determines whether the query should join in the structure data."
withStructure: Boolean
): CategoryInterface
"The element’s right position within its structure."
rgt: Int
"The element’s structure’s root ID"
root: Int
"The element’s search score, if the `search` parameter was used when querying for the element."
searchScore: Int
"This query is used to query for SEOmatic meta data."
seomatic(
"Whether the meta items should be returned as an array or as pre-rendered tag text."
asArray: Boolean,
environment: SeomaticEnvironment,
"Optional - The site handle to resolve the SEOmatic metdata for."
site: String,
"Optional - The site ID to resolve the SEOmatic metdata for."
siteId: Int,
"The URI to resolve the SEOmatic metdata for."
uri: String
): SeomaticInterface
"The ID of the site the element is associated with."
siteId: Int
"The unique identifier for an element-site relation."
siteSettingsId: ID
"The element’s slug."
slug: String
"The element’s status."
status: String
"The element’s structure ID."
structureId: Int
"The element’s title."
title: String
"Whether the element has been soft-deleted or not."
trashed: Boolean
"The UID of the entity"
uid: String
"The element’s URI."
uri: String