Query Parameters

GET /items/posts
	?fields=first_name,last_name,avatar.description

Use native GraphQL queries.

{
	"fields": ["first_name", "last_name", { "avatar": ["description"] }]
}

::code-group
```http [REST]

  # Use can use native GraphQL Union types.

  query {
  	posts {
  		sections {
  			item {
  				... on headings {
  					title
  					level
  				}
  				... on paragraphs {
  					body
  				}
  				... on videos {
  					source
  				}
  			}
  		}
  	}
  }
  ```

  ```js [SDK]
  import { createDirectus, rest, readItems } from '@directus/sdk';
  const directus = createDirectus('https://directus.example.com').with(rest());

  const result = await directus.request(
  	readItems('posts', {
  		fields: [
  			'title',
  			{
  				sections: [
  					{
  						item: {
  							headings: ['title', 'level'],
  							paragraphs: ['body'],
  							videos: ['source'],
  						}
  					}
  				]
  			}
  		],
  	})
  );
  ```
  ::

::

## Filter

Specify which items are returned based on the result of a [filter rule](/guides/connect/filter-rules).

::code-group

```http [REST]
// There are two available syntax:

GET /items/posts
  ?filter[title][_eq]=Hello

GET /items/posts
  ?filter={ "title": { "_eq": "Hello" }}

query {
	posts(filter: { title: { _eq: "Hello" } }) {
		id
	}
}

# Attribute names in GraphQL cannot contain the `:` character. If you are filtering Many to Any fields, you will need to replace it with a double underscore.

import { createDirectus, rest, readItems } from '@directus/sdk';
const directus = createDirectus('https://directus.example.com').with(rest());

const result = await directus.request(
	readItems('posts', {
		filter: {
			title: {
				_eq: 'Hello',
			},
		},
	})
);

GET /items/posts
	?search=Directus

query {
	posts(search: "Directus") {
		id
	}
}

import { createDirectus, rest, readItems } from '@directus/sdk';
const directus = createDirectus('https://directus.example.com').with(rest());

const result = await directus.request(
	readItems('posts', {
		search: 'Directus',
	})
);

GET /items/posts
	?sort=sort,-date_created,author.name

query {
	posts(sort: ["sort", "-date_created", "author.name"]) {
		id
	}
}

import { createDirectus, rest, readItems } from '@directus/sdk';
const directus = createDirectus('https://directus.example.com').with(rest());

const result = await directus.request(
	readItems('posts', {
		sort: ['sort', '-date_created', 'author.name'],
	})
);

GET /items/posts
	?limit=50

query {
	posts(limit: 50) {
		id
	}
}

import { createDirectus, rest, readItems } from '@directus/sdk';
const directus = createDirectus('https://directus.example.com').with(rest());

const result = await directus.request(
	readItems('posts', {
		limit: 50,
	})
);

GET /items/posts
	?offset=100

query {
	posts(offset: 100) {
		id
	}
}

import { createDirectus, rest, readItems } from '@directus/sdk';
const directus = createDirectus('https://directus.example.com').with(rest());

const result = await directus.request(
	readItems('posts', {
		offset: 100,
	})
);

GET /items/posts
	?page=2

query {
	posts(page: 2) {
		id
	}
}

import { createDirectus, rest, readItems } from '@directus/sdk';
const directus = createDirectus('https://directus.example.com').with(rest());

const result = await directus.request(
	readItems('posts', {
		page: 2,
	})
);

GET /items/posts
	?aggregate[count]=*

query {
	posts_aggregated {
		countAll
	}
}

import { createDirectus, rest, aggregate } from '@directus/sdk';
const directus = createDirectus('https://directus.example.com').with(rest());

const result = await directus.request(
	aggregate('posts', {
		aggregate: { count: '*' },
	})
);

GET /items/posts
  ?aggregate[count]=views,comments
  &groupBy[]=author
  &groupBy[]=year(publish_date)

query {
  posts_aggregated(groupBy: ["author", "year(publish_date)"]) {
    group
    count {
      views
      comments
    }
  }
}

import { createDirectus, rest, aggregate } from '@directus/sdk';
const directus = createDirectus('https://directus.example.com').with(rest());

const result = await directus.request(
  aggregate('posts', {
    aggregate: {
      count: ['views', 'comments']
    },
    groupBy: ['author', 'year(publish_date)'],
  })
);

// There are two available syntax:

GET /items/posts
	?deep[translations][_filter][languages_code][_eq]=en-US

GET /items/posts
	?deep={ "translations": { "_filter": { "languages_code": { "_eq": "en-US" }}}}

# Natively supported by GraphQL.
query {
	posts {
		translations(filter: { languages_code: { code: { _eq: "en-US" } } }) {
			id
		}
	}
}

import { createDirectus, rest, readItems } from '@directus/sdk';
const directus = createDirectus('https://directus.example.com').with(rest());

const result = await directus.request(
	readItems('posts', {
		deep: {
			translations: {
				_filter: {
					languages_code: {
						_eq: 'en-US',
					},
				}
			},
		},
	})
);

{
	"deep": {
		"related_posts": {
			"_limit": 3,
			"comments": {
				"_sort": "rating",
				"_limit": 1
			}
		}
  }
}

GET /items/posts
	?alias[all_translations]=translations
	&alias[dutch_translations]=translations
	&deep[dutch_translations][_filter][code][_eq]=nl-NL

# Natively supported by GraphQL.
query {
	posts {
		dutch_translations: translations(filter: { code: { _eq: "nl-NL" } }) {
			id
		}

		all_translations: translations {
			id
		}
	}
}

import { createDirectus, rest, readItems } from '@directus/sdk';
const directus = createDirectus('https://directus.example.com').with(staticToken()).with(rest());

const result = await directus.request(
	readItems('posts', {
		alias: {
			all_translations: 'translations',
			dutch_translations: 'translations',
		},
		deep: {
			dutch_translations: {
				_filter: {
					code: {
						_eq: 'nl-NL',
					},
				},
			},
		},
	})
);

?export=type

?version=v1

query {
  posts_by_id(id: 1, version: "v1") {
    id
  }
}

import { createDirectus, rest, readItem } from "@directus/sdk";
const directus = createDirectus("https://directus.example.com").with(rest());

const result = await directus.request(
  readItem("posts", {
    version: "v1",
  })
);

?version=v1&versionRaw=true

query {
  posts_by_version(id: 1, version: "v1") {
    id
  }
}

import { createDirectus, rest, readItem } from "@directus/sdk";
const directus = createDirectus("https://directus.example.com").with(rest());

const result = await directus.request(
  readItem("posts", {
    version: "v1",
    versionRaw: true,
  })
);

GET /items/posts
	?filter[year(date_published)][_eq]=1968

query {
	posts(filter: { date_published_func: { year: { _eq: 1968 } } }) {
		id
	}
}

# Due to GraphQL name limitations, append `_func` at the end of the field name and use the function name as the nested field.

import { createDirectus, rest, readItems } from '@directus/sdk';
const directus = createDirectus('https://directus.example.com').with(rest());

const result = await directus.request(
	readItems('posts', {
		filter: {
			"year(date_published)": {
				_eq: 1968
			}
		},
	})
);

GET /items/posts
	?fields=*.*.*
    &backlink=false

import { createDirectus, rest, readItems } from "@directus/sdk";
const directus = createDirectus("https://directus.example.com").with(rest());

const result = await directus.request(
  readItems("posts", {
    backlink: false,
  })
);

{
  "data": [
    {
      "id": 1,
      "title": "My first Article",
      "author": {
        "id": 2,
        "name": "Nils",
        "articles": [
          { // [!code --]
            "id": 1, // [!code --]
            "title": "My first Article", // [!code --]
            "author": { // [!code --]
              "id": 2, // [!code --]
              "name": "Nils", // [!code --]
              "articles": [1] // [!code --]
            }, // [!code --]
            "tags": [ // [!code --]
              { // [!code --]
                "id": 3, // [!code --]
                "articles_id": 1, // [!code --]
                "tags_id": 4 // [!code --]
              } // [!code --]
            ] // [!code --]
          } // [!code --]
          1 // [!code ++]
        ]
      },
      "tags": [
        {
          "id": 3,
          "articles_id": { // [!code --]
            "id": 1, // [!code --]
            "title": "My first Article", // [!code --]
            "author": { // [!code --]
              "id": 2, // [!code --]
              "name": "Nils", // [!code --]
              "articles": [1] // [!code --]
            },  // [!code --]
            "tags": [ // [!code --]
              { // [!code --]
                "id": 3, // [!code --]
                "articles_id": 1, // [!code --]
                "tags_id": 4 // [!code --]
              } // [!code --]
            ] // [!code --]
          }, // [!code --]
          "articles_id": 1, // [!code ++]
          "tags_id": {
            "id": 4,
            "tag": "Tag1",
            "articles": [
              { // [!code --]
                "id": 3, // [!code --]
                "articles_id": 1, // [!code --]
                "tags_id": 4 // [!code --]
              } // [!code --]
              3 // [!code ++]
            ]
          }
        }
      ]
    }
  ]
}