Movatterモバイル変換

Query parameters help you optimize Microsoft Graph API responses by controlling exactly what data is returned. Instead of retrieving all available properties and data, you can use query parameters to:

Filter results to get only the records you need
Select specific properties to reduce response size and improve performance
Sort and paginate data for better user experiences
Expand related resources to get connected data in a single request

This article explains how to useOData system query options and other Microsoft Graph query parameters effectively. You learn the syntax, see practical examples, and discover best practices for building efficient queries that enhance your application's performance.

Support for specific query parameters varies between API operations and can differ between thev1.0 andbeta endpoints.

Tip

On thebeta endpoint, the$ prefix is optional. For example, you can usefilter instead of$filter.On thev1.0 endpoint, the$ prefix is optional for only a subset of APIs.For simplicity, always include$ across all versions.

OData system query options

A Microsoft Graph API operation might support one or more of the following OData system query options. These query options are compatible with theOData V4 query language and are supported only inGET operations.

Select the examples to try them inGraph Explorer.

Name	Description	Example
$count	Returns the total count of matching resources.	`/me/messages?$top=2&$count=true`
$expand	Returns related resources.	`/groups?$expand=members`
$filter	Filters results (rows).	`/users?$filter=startswith(givenName,'J')`
$format	Returns results in the specified media format.	`/users?$format=json`
$orderby	Orders results.	`/users?$orderby=displayName desc`
$search	Returns results based on search criteria.	`/me/messages?$search=pizza`
$select	Filters properties (columns).	`/users?$select=givenName,surname`
$skip	Skips items in a result set. Also used by some APIs to implement paging and can be used with`$top` to manually page results.	`/me/messages?$skip=11`
$top	Sets the page size of results.	`/users?$top=2`

To find the OData system query options that an API and its properties support, see the "Properties" table in the resource page and the "Optional query parameters" section of the LIST and GET operations for the API.

Other query parameters

Name	Description	Example
$skipToken	Returns the next page of results from result sets that span multiple pages. (Some APIs use`$skip` instead.)	`/users?$skiptoken=X%274453707402000100000017...`

Other OData URL capabilities

The following OData 4.0 capabilities are URL segments, not query parameters.

Name	Description	Example
$count	Returns the integer total of the collection.	`GET /users/$count` `GET /groups/{id}/members/$count` Get a count of users
$ref	Updates entities membership to a collection.	`POST /groups/{id}/members/$ref` Add a member to a group
$value	Returns or updates the binary value of an item.	`GET /me/photo/$value` Get the photo for a user, group, or team
$batch	Combines multiple HTTP requests into a batch request.	`POST /$batch` JSON batching

Encoding query parameters

Percent-encode query parameter values according toRFC 3986. All reserved characters in query strings must be percent-encoded. Many HTTP clients, browsers, and tools (such as theGraph Explorer) handle this encoding automatically. If a query fails, a possible cause is failure to encode the query parameter values appropriately. Sometimes, you need to double-encode values.

Note

There's a known issue with encoding ampersand (&) symbols in$search expressions on thev1.0 endpoint. For more information about the issue and the recommended workaround, seeKnown issue: $search for directory objects fails for encoded ampersand (&) character.

For example, an unencoded URL looks like this:

GET https://graph.microsoft.com/v1.0/users?$filter=startswith(givenName, 'J')

// Code snippets are only available for the latest version. Current version is 5.x// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharpvar result = await graphClient.Users.GetAsync((requestConfiguration) =>{requestConfiguration.QueryParameters.Filter = "startswith(givenName, 'J')";});

// Code snippets are only available for the latest major version. Current major version is $v1.*// Dependenciesimport (  "context"  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"  graphusers "github.com/microsoftgraph/msgraph-sdk-go/users"  //other-imports)requestFilter := "startswith(givenName, 'J')"requestParameters := &graphusers.UsersRequestBuilderGetQueryParameters{Filter: &requestFilter,}configuration := &graphusers.UsersRequestBuilderGetRequestConfiguration{QueryParameters: requestParameters,}// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=gousers, err := graphClient.Users().Get(context.Background(), configuration)

// Code snippets are only available for the latest version. Current version is 6.xGraphServiceClient graphClient = new GraphServiceClient(requestAdapter);UserCollectionResponse result = graphClient.users().get(requestConfiguration -> {requestConfiguration.queryParameters.filter = "startswith(givenName, 'J')";});

const options = {authProvider,};const client = Client.init(options);let users = await client.api('/users').filter('startswith(givenName, \'J\')').get();

<?phpuse Microsoft\Graph\GraphServiceClient;use Microsoft\Graph\Generated\Users\UsersRequestBuilderGetRequestConfiguration;$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);$requestConfiguration = new UsersRequestBuilderGetRequestConfiguration();$queryParameters = UsersRequestBuilderGetRequestConfiguration::createQueryParameters();$queryParameters->filter = "startswith(givenName, 'J')";$requestConfiguration->queryParameters = $queryParameters;$result = $graphServiceClient->users()->get($requestConfiguration)->wait();

Import-Module Microsoft.Graph.UsersGet-MgUser -Filter "startswith(givenName, 'J')"

# Code snippets are only available for the latest version. Current version is 1.xfrom msgraph import GraphServiceClientfrom msgraph.generated.users.users_request_builder import UsersRequestBuilderfrom kiota_abstractions.base_request_configuration import RequestConfiguration# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=pythonquery_params = UsersRequestBuilder.UsersRequestBuilderGetQueryParameters(filter = "startswith(givenName, 'J')",)request_configuration = RequestConfiguration(query_parameters = query_params,)result = await graph_client.users.get(request_configuration = request_configuration)

The properly percent-encoded URL looks like this:

GET https://graph.microsoft.com/v1.0/users?$filter=startswith(givenName%2C+'J')

// Code snippets are only available for the latest version. Current version is 5.x// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharpvar result = await graphClient.Users.GetAsync((requestConfiguration) =>{requestConfiguration.QueryParameters.Filter = "startswith(givenName, 'J')";});

// Code snippets are only available for the latest major version. Current major version is $v1.*// Dependenciesimport (  "context"  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"  graphusers "github.com/microsoftgraph/msgraph-sdk-go/users"  //other-imports)requestFilter := "startswith(givenName, 'J')"requestParameters := &graphusers.UsersRequestBuilderGetQueryParameters{Filter: &requestFilter,}configuration := &graphusers.UsersRequestBuilderGetRequestConfiguration{QueryParameters: requestParameters,}// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=gousers, err := graphClient.Users().Get(context.Background(), configuration)

// Code snippets are only available for the latest version. Current version is 6.xGraphServiceClient graphClient = new GraphServiceClient(requestAdapter);UserCollectionResponse result = graphClient.users().get(requestConfiguration -> {requestConfiguration.queryParameters.filter = "startswith(givenName, 'J')";});

const options = {authProvider,};const client = Client.init(options);let users = await client.api('/users').filter('startswith(givenName, \'J\')').get();

<?phpuse Microsoft\Graph\GraphServiceClient;use Microsoft\Graph\Generated\Users\UsersRequestBuilderGetRequestConfiguration;$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);$requestConfiguration = new UsersRequestBuilderGetRequestConfiguration();$queryParameters = UsersRequestBuilderGetRequestConfiguration::createQueryParameters();$queryParameters->filter = "startswith(givenName, 'J')";$requestConfiguration->queryParameters = $queryParameters;$result = $graphServiceClient->users()->get($requestConfiguration)->wait();

Import-Module Microsoft.Graph.UsersGet-MgUser -Filter "startswith(givenName, 'J')"

# Code snippets are only available for the latest version. Current version is 1.xfrom msgraph import GraphServiceClientfrom msgraph.generated.users.users_request_builder import UsersRequestBuilderfrom kiota_abstractions.base_request_configuration import RequestConfiguration# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=pythonquery_params = UsersRequestBuilder.UsersRequestBuilderGetQueryParameters(filter = "startswith(givenName, 'J')",)request_configuration = RequestConfiguration(query_parameters = query_params,)result = await graph_client.users.get(request_configuration = request_configuration)

The double-encoded URL looks like this:

GET https://graph.microsoft.com/v1.0/users?$filter=startswith%28givenName%2C%20%27J%27%29

// Code snippets are only available for the latest version. Current version is 5.x// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharpvar result = await graphClient.Users.GetAsync((requestConfiguration) =>{requestConfiguration.QueryParameters.Filter = "startswith(givenName, 'J')";});

// Code snippets are only available for the latest major version. Current major version is $v1.*// Dependenciesimport (  "context"  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"  graphusers "github.com/microsoftgraph/msgraph-sdk-go/users"  //other-imports)requestFilter := "startswith(givenName, 'J')"requestParameters := &graphusers.UsersRequestBuilderGetQueryParameters{Filter: &requestFilter,}configuration := &graphusers.UsersRequestBuilderGetRequestConfiguration{QueryParameters: requestParameters,}// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=gousers, err := graphClient.Users().Get(context.Background(), configuration)

// Code snippets are only available for the latest version. Current version is 6.xGraphServiceClient graphClient = new GraphServiceClient(requestAdapter);UserCollectionResponse result = graphClient.users().get(requestConfiguration -> {requestConfiguration.queryParameters.filter = "startswith(givenName, 'J')";});

const options = {authProvider,};const client = Client.init(options);let users = await client.api('/users').filter('startswith(givenName, \'J\')').get();

<?phpuse Microsoft\Graph\GraphServiceClient;use Microsoft\Graph\Generated\Users\UsersRequestBuilderGetRequestConfiguration;$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);$requestConfiguration = new UsersRequestBuilderGetRequestConfiguration();$queryParameters = UsersRequestBuilderGetRequestConfiguration::createQueryParameters();$queryParameters->filter = "startswith(givenName, 'J')";$requestConfiguration->queryParameters = $queryParameters;$result = $graphServiceClient->users()->get($requestConfiguration)->wait();

Import-Module Microsoft.Graph.UsersGet-MgUser -Filter "startswith(givenName, 'J')"

# Code snippets are only available for the latest version. Current version is 1.xfrom msgraph import GraphServiceClientfrom msgraph.generated.users.users_request_builder import UsersRequestBuilderfrom kiota_abstractions.base_request_configuration import RequestConfiguration# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=pythonquery_params = UsersRequestBuilder.UsersRequestBuilderGetQueryParameters(filter = "startswith(givenName, 'J')",)request_configuration = RequestConfiguration(query_parameters = query_params,)result = await graph_client.users.get(request_configuration = request_configuration)

Escaping single quotes

For requests that use single quotes, if any parameter values also contain single quotes, they should be double escaped; otherwise, the request fails because of invalid syntax. In the example, the string valuelet''s meet for lunch? has the single quote escaped.

GET https://graph.microsoft.com/v1.0/me/messages?$filter=subject eq 'let''s meet for lunch?'

// Code snippets are only available for the latest version. Current version is 5.x// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharpvar result = await graphClient.Me.Messages.GetAsync((requestConfiguration) =>{requestConfiguration.QueryParameters.Filter = "subject eq 'let''s meet for lunch?'";});

// Code snippets are only available for the latest major version. Current major version is $v1.*// Dependenciesimport (  "context"  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"  graphusers "github.com/microsoftgraph/msgraph-sdk-go/users"  //other-imports)requestFilter := "subject eq 'let''s meet for lunch?'"requestParameters := &graphusers.ItemMessagesRequestBuilderGetQueryParameters{Filter: &requestFilter,}configuration := &graphusers.ItemMessagesRequestBuilderGetRequestConfiguration{QueryParameters: requestParameters,}// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=gomessages, err := graphClient.Me().Messages().Get(context.Background(), configuration)

// Code snippets are only available for the latest version. Current version is 6.xGraphServiceClient graphClient = new GraphServiceClient(requestAdapter);MessageCollectionResponse result = graphClient.me().messages().get(requestConfiguration -> {requestConfiguration.queryParameters.filter = "subject eq 'let''s meet for lunch?'";});

const options = {authProvider,};const client = Client.init(options);let messages = await client.api('/me/messages').filter('subject eq \'let\'\'s meet for lunch?\'').get();

<?phpuse Microsoft\Graph\GraphServiceClient;use Microsoft\Graph\Generated\Users\Item\Messages\MessagesRequestBuilderGetRequestConfiguration;$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);$requestConfiguration = new MessagesRequestBuilderGetRequestConfiguration();$queryParameters = MessagesRequestBuilderGetRequestConfiguration::createQueryParameters();$queryParameters->filter = "subject eq 'let''s meet for lunch?'";$requestConfiguration->queryParameters = $queryParameters;$result = $graphServiceClient->me()->messages()->get($requestConfiguration)->wait();

Import-Module Microsoft.Graph.Mail# A UPN can also be used as -UserId.Get-MgUserMessage -UserId $userId -Filter "subject eq 'let''s meet for lunch?'"

# Code snippets are only available for the latest version. Current version is 1.xfrom msgraph import GraphServiceClientfrom msgraph.generated.users.item.messages.messages_request_builder import MessagesRequestBuilderfrom kiota_abstractions.base_request_configuration import RequestConfiguration# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=pythonquery_params = MessagesRequestBuilder.MessagesRequestBuilderGetQueryParameters(filter = "subject eq 'let''s meet for lunch?'",)request_configuration = RequestConfiguration(query_parameters = query_params,)result = await graph_client.me.messages.get(request_configuration = request_configuration)

Count

Use the$count query parameter to get the count of the total number of items in a collection or matching an expression. You can use$count in the following ways:

As a query string parameter with the syntax$count=true to include a count of the total number of items in a collection alongside the page of data values returned from Microsoft Graph. For example,users?$count=true.
As aURL segment to get only the integer total of the collection. For example,users/$count.
In a$filter expression with equality operators to get a collection of data where the filtered property is an empty collection. SeeUse the $filter query parameter to filter a collection of objects.

Note

On resources that derive fromdirectoryObject,$count is only supported in an advanced query. SeeAdvanced query capabilities on directory objects.
Use of$count isn't supported in Azure AD B2C tenants.

For example, the following request returns both thecontact collection of the current user and the number of items in thecontact collection in an@odata.count property.

GET  https://graph.microsoft.com/v1.0/me/contacts?$count=true

// Code snippets are only available for the latest version. Current version is 5.x// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharpvar result = await graphClient.Me.Contacts.GetAsync((requestConfiguration) =>{requestConfiguration.QueryParameters.Count = true;});

// Code snippets are only available for the latest major version. Current major version is $v1.*// Dependenciesimport (  "context"  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"  graphusers "github.com/microsoftgraph/msgraph-sdk-go/users"  //other-imports)requestCount := truerequestParameters := &graphusers.ItemContactsRequestBuilderGetQueryParameters{Count: &requestCount,}configuration := &graphusers.ItemContactsRequestBuilderGetRequestConfiguration{QueryParameters: requestParameters,}// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=gocontacts, err := graphClient.Me().Contacts().Get(context.Background(), configuration)

// Code snippets are only available for the latest version. Current version is 6.xGraphServiceClient graphClient = new GraphServiceClient(requestAdapter);ContactCollectionResponse result = graphClient.me().contacts().get(requestConfiguration -> {requestConfiguration.queryParameters.count = true;});

const options = {authProvider,};const client = Client.init(options);let contacts = await client.api('/me/contacts').get();

<?phpuse Microsoft\Graph\GraphServiceClient;use Microsoft\Graph\Generated\Users\Item\Contacts\ContactsRequestBuilderGetRequestConfiguration;$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);$requestConfiguration = new ContactsRequestBuilderGetRequestConfiguration();$queryParameters = ContactsRequestBuilderGetRequestConfiguration::createQueryParameters();$queryParameters->count = true;$requestConfiguration->queryParameters = $queryParameters;$result = $graphServiceClient->me()->contacts()->get($requestConfiguration)->wait();

Import-Module Microsoft.Graph.PersonalContacts# A UPN can also be used as -UserId.Get-MgUserContact -UserId $userId -CountVariable CountVar

# Code snippets are only available for the latest version. Current version is 1.xfrom msgraph import GraphServiceClientfrom msgraph.generated.users.item.contacts.contacts_request_builder import ContactsRequestBuilderfrom kiota_abstractions.base_request_configuration import RequestConfiguration# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=pythonquery_params = ContactsRequestBuilder.ContactsRequestBuilderGetQueryParameters(count = True,)request_configuration = RequestConfiguration(query_parameters = query_params,)result = await graph_client.me.contacts.get(request_configuration = request_configuration)

For directory objects, that is, resources that derive fromdirectoryObject, the$count query parameter is only supported inadvanced queries.

Expand

Many Microsoft Graph resources expose both declared properties of the resource and its relationships with other resources. These relationships are also called reference properties or navigation properties, and they can reference either a single resource or a collection of resources. For example, the mail folders, manager, and direct reports of a user are all exposed as relationships.

You can use the$expand query string parameter to include the expanded resource or collection referenced by a single relationship (navigation property) in your results. For some APIs, only one relationship can be expanded in a single request.

The following example gets root drive information along with the top-level child items in a drive:

GET https://graph.microsoft.com/v1.0/me/drive/root?$expand=children

// Code snippets are only available for the latest version. Current version is 5.x// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharpvar result = await graphClient.Drives["{drive-id}"].Root.GetAsync((requestConfiguration) =>{requestConfiguration.QueryParameters.Expand = new string []{ "children" };});

// Code snippets are only available for the latest major version. Current major version is $v1.*// Dependenciesimport (  "context"  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"  graphdrives "github.com/microsoftgraph/msgraph-sdk-go/drives"  //other-imports)requestParameters := &graphdrives.ItemRootRequestBuilderGetQueryParameters{Expand: [] string {"children"},}configuration := &graphdrives.ItemRootRequestBuilderGetRequestConfiguration{QueryParameters: requestParameters,}// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=goroot, err := graphClient.Drives().ByDriveId("drive-id").Root().Get(context.Background(), configuration)

// Code snippets are only available for the latest version. Current version is 6.xGraphServiceClient graphClient = new GraphServiceClient(requestAdapter);DriveItem result = graphClient.drives().byDriveId("{drive-id}").root().get(requestConfiguration -> {requestConfiguration.queryParameters.expand = new String []{"children"};});

const options = {authProvider,};const client = Client.init(options);let driveItem = await client.api('/me/drive/root').expand('children').get();

<?phpuse Microsoft\Graph\GraphServiceClient;use Microsoft\Graph\Generated\Drives\Item\Root\RootRequestBuilderGetRequestConfiguration;$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);$requestConfiguration = new RootRequestBuilderGetRequestConfiguration();$queryParameters = RootRequestBuilderGetRequestConfiguration::createQueryParameters();$queryParameters->expand = ["children"];$requestConfiguration->queryParameters = $queryParameters;$result = $graphServiceClient->drives()->byDriveId('drive-id')->root()->get($requestConfiguration)->wait();

Import-Module Microsoft.Graph.FilesGet-MgDriveRoot -DriveId $driveId -ExpandProperty "children"

# Code snippets are only available for the latest version. Current version is 1.xfrom msgraph import GraphServiceClientfrom msgraph.generated.drives.item.root.root_request_builder import RootRequestBuilderfrom kiota_abstractions.base_request_configuration import RequestConfiguration# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=pythonquery_params = RootRequestBuilder.RootRequestBuilderGetQueryParameters(expand = ["children"],)request_configuration = RequestConfiguration(query_parameters = query_params,)result = await graph_client.drives.by_drive_id('drive-id').root.get(request_configuration = request_configuration)

With some resource collections, you can also specify the properties to be returned in the expanded resources by adding a$select parameter. The following example performs the same query as the previous example but uses a$select statement to limit the properties returned for the expanded child items to theid andname properties.

GET https://graph.microsoft.com/v1.0/me/drive/root?$expand=children($select=id,name)

// Code snippets are only available for the latest version. Current version is 5.x// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharpvar result = await graphClient.Drives["{drive-id}"].Root.GetAsync((requestConfiguration) =>{requestConfiguration.QueryParameters.Expand = new string []{ "children($select=id,name)" };});

// Code snippets are only available for the latest major version. Current major version is $v1.*// Dependenciesimport (  "context"  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"  graphdrives "github.com/microsoftgraph/msgraph-sdk-go/drives"  //other-imports)requestParameters := &graphdrives.ItemRootRequestBuilderGetQueryParameters{Expand: [] string {"children($select=id,name)"},}configuration := &graphdrives.ItemRootRequestBuilderGetRequestConfiguration{QueryParameters: requestParameters,}// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=goroot, err := graphClient.Drives().ByDriveId("drive-id").Root().Get(context.Background(), configuration)

// Code snippets are only available for the latest version. Current version is 6.xGraphServiceClient graphClient = new GraphServiceClient(requestAdapter);DriveItem result = graphClient.drives().byDriveId("{drive-id}").root().get(requestConfiguration -> {requestConfiguration.queryParameters.expand = new String []{"children($select=id,name)"};});

const options = {authProvider,};const client = Client.init(options);let driveItem = await client.api('/me/drive/root').expand('children($select=id,name)').get();

<?phpuse Microsoft\Graph\GraphServiceClient;use Microsoft\Graph\Generated\Drives\Item\Root\RootRequestBuilderGetRequestConfiguration;$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);$requestConfiguration = new RootRequestBuilderGetRequestConfiguration();$queryParameters = RootRequestBuilderGetRequestConfiguration::createQueryParameters();$queryParameters->expand = ["children(\$select=id,name)"];$requestConfiguration->queryParameters = $queryParameters;$result = $graphServiceClient->drives()->byDriveId('drive-id')->root()->get($requestConfiguration)->wait();

Import-Module Microsoft.Graph.FilesGet-MgDriveRoot -DriveId $driveId -ExpandProperty "children(`$select=id,name)"

# Code snippets are only available for the latest version. Current version is 1.xfrom msgraph import GraphServiceClientfrom msgraph.generated.drives.item.root.root_request_builder import RootRequestBuilderfrom kiota_abstractions.base_request_configuration import RequestConfiguration# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=pythonquery_params = RootRequestBuilder.RootRequestBuilderGetQueryParameters(expand = ["children($select=id,name)"],)request_configuration = RequestConfiguration(query_parameters = query_params,)result = await graph_client.drives.by_drive_id('drive-id').root.get(request_configuration = request_configuration)

Note

Not all relationships and resources support the$expand query parameter. For example, you can expand thedirectReports,manager, andmemberOf relationships on a user, but you can't expand itsevents,messages, orphoto relationships. Not all resources or relationships support using$select on expanded items.
With Microsoft Entra resources that derive fromdirectoryObject, likeuser andgroup,$expand typically returns a maximum of 20 items for the expanded relationship and has no@odata.nextLink. For details, seequery parameter limitations.
$expand isn't currently supported withadvanced queries.

Filter

Use the$filter query parameter to get just a subset of a collection. For guidance on using$filter, seeUse the $filter query parameter to filter a collection of objects.

Format

Use the$format query parameter to specify the media format of the items returned from Microsoft Graph.

For example, the following request returns the users in the organization in JSON format:

GET https://graph.microsoft.com/v1.0/users?$format=json

// Code snippets are only available for the latest version. Current version is 5.x// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharpvar result = await graphClient.Users.GetAsync((requestConfiguration) =>{requestConfiguration.QueryParameters.Format = "json";});

// Code snippets are only available for the latest major version. Current major version is $v1.*// Dependenciesimport (  "context"  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"  graphusers "github.com/microsoftgraph/msgraph-sdk-go/users"  //other-imports)requestFormat := "json"requestParameters := &graphusers.UsersRequestBuilderGetQueryParameters{Format: &requestFormat,}configuration := &graphusers.UsersRequestBuilderGetRequestConfiguration{QueryParameters: requestParameters,}// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=gousers, err := graphClient.Users().Get(context.Background(), configuration)

// Code snippets are only available for the latest version. Current version is 6.xGraphServiceClient graphClient = new GraphServiceClient(requestAdapter);UserCollectionResponse result = graphClient.users().get(requestConfiguration -> {requestConfiguration.queryParameters.format = "json";});

const options = {authProvider,};const client = Client.init(options);let users = await client.api('/users').get();

<?phpuse Microsoft\Graph\GraphServiceClient;use Microsoft\Graph\Generated\Users\UsersRequestBuilderGetRequestConfiguration;$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);$requestConfiguration = new UsersRequestBuilderGetRequestConfiguration();$queryParameters = UsersRequestBuilderGetRequestConfiguration::createQueryParameters();$queryParameters->format = "json";$requestConfiguration->queryParameters = $queryParameters;$result = $graphServiceClient->users()->get($requestConfiguration)->wait();

Import-Module Microsoft.Graph.UsersGet-MgUser -Format "json"

# Code snippets are only available for the latest version. Current version is 1.xfrom msgraph import GraphServiceClientfrom msgraph.generated.users.users_request_builder import UsersRequestBuilderfrom kiota_abstractions.base_request_configuration import RequestConfiguration# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=pythonquery_params = UsersRequestBuilder.UsersRequestBuilderGetQueryParameters(format = "json",)request_configuration = RequestConfiguration(query_parameters = query_params,)result = await graph_client.users.get(request_configuration = request_configuration)

Note

The$format query parameter supports many formats (for example,atom,xml, andjson) but results might not be returned in all formats.

OrderBy

Use the$orderby query parameter to specify the sort order of the items returned from Microsoft Graph. The default order is ascending.

For example, the following request returns users in the organization ordered by their display name in ascending order:

GET https://graph.microsoft.com/v1.0/users?$orderby=displayName

// Code snippets are only available for the latest version. Current version is 5.x// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharpvar result = await graphClient.Users.GetAsync((requestConfiguration) =>{requestConfiguration.QueryParameters.Orderby = new string []{ "displayName" };});

// Code snippets are only available for the latest major version. Current major version is $v1.*// Dependenciesimport (  "context"  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"  graphusers "github.com/microsoftgraph/msgraph-sdk-go/users"  //other-imports)requestParameters := &graphusers.UsersRequestBuilderGetQueryParameters{Orderby: [] string {"displayName"},}configuration := &graphusers.UsersRequestBuilderGetRequestConfiguration{QueryParameters: requestParameters,}// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=gousers, err := graphClient.Users().Get(context.Background(), configuration)

// Code snippets are only available for the latest version. Current version is 6.xGraphServiceClient graphClient = new GraphServiceClient(requestAdapter);UserCollectionResponse result = graphClient.users().get(requestConfiguration -> {requestConfiguration.queryParameters.orderby = new String []{"displayName"};});

const options = {authProvider,};const client = Client.init(options);let users = await client.api('/users').orderby('displayName').get();

<?phpuse Microsoft\Graph\GraphServiceClient;use Microsoft\Graph\Generated\Users\UsersRequestBuilderGetRequestConfiguration;$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);$requestConfiguration = new UsersRequestBuilderGetRequestConfiguration();$queryParameters = UsersRequestBuilderGetRequestConfiguration::createQueryParameters();$queryParameters->orderby = ["displayName"];$requestConfiguration->queryParameters = $queryParameters;$result = $graphServiceClient->users()->get($requestConfiguration)->wait();

Import-Module Microsoft.Graph.UsersGet-MgUser -Sort "displayName"

# Code snippets are only available for the latest version. Current version is 1.xfrom msgraph import GraphServiceClientfrom msgraph.generated.users.users_request_builder import UsersRequestBuilderfrom kiota_abstractions.base_request_configuration import RequestConfiguration# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=pythonquery_params = UsersRequestBuilder.UsersRequestBuilderGetQueryParameters(orderby = ["displayName"],)request_configuration = RequestConfiguration(query_parameters = query_params,)result = await graph_client.users.get(request_configuration = request_configuration)

Some APIs support sorting by complex type entities. The following request gets messages and sorts them by theaddress field of thefrom property, which is of the complex typeemailAddress:

GET https://graph.microsoft.com/v1.0/me/messages?$orderby=from/emailAddress/address

// Code snippets are only available for the latest version. Current version is 5.x// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharpvar result = await graphClient.Me.Messages.GetAsync((requestConfiguration) =>{requestConfiguration.QueryParameters.Orderby = new string []{ "from/emailAddress/address" };});

// Code snippets are only available for the latest major version. Current major version is $v1.*// Dependenciesimport (  "context"  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"  graphusers "github.com/microsoftgraph/msgraph-sdk-go/users"  //other-imports)requestParameters := &graphusers.ItemMessagesRequestBuilderGetQueryParameters{Orderby: [] string {"from/emailAddress/address"},}configuration := &graphusers.ItemMessagesRequestBuilderGetRequestConfiguration{QueryParameters: requestParameters,}// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=gomessages, err := graphClient.Me().Messages().Get(context.Background(), configuration)

// Code snippets are only available for the latest version. Current version is 6.xGraphServiceClient graphClient = new GraphServiceClient(requestAdapter);MessageCollectionResponse result = graphClient.me().messages().get(requestConfiguration -> {requestConfiguration.queryParameters.orderby = new String []{"from/emailAddress/address"};});

const options = {authProvider,};const client = Client.init(options);let messages = await client.api('/me/messages').orderby('from/emailAddress/address').get();

<?phpuse Microsoft\Graph\GraphServiceClient;use Microsoft\Graph\Generated\Users\Item\Messages\MessagesRequestBuilderGetRequestConfiguration;$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);$requestConfiguration = new MessagesRequestBuilderGetRequestConfiguration();$queryParameters = MessagesRequestBuilderGetRequestConfiguration::createQueryParameters();$queryParameters->orderby = ["from/emailAddress/address"];$requestConfiguration->queryParameters = $queryParameters;$result = $graphServiceClient->me()->messages()->get($requestConfiguration)->wait();

Import-Module Microsoft.Graph.Mail# A UPN can also be used as -UserId.Get-MgUserMessage -UserId $userId -Sort "from/emailAddress/address"

# Code snippets are only available for the latest version. Current version is 1.xfrom msgraph import GraphServiceClientfrom msgraph.generated.users.item.messages.messages_request_builder import MessagesRequestBuilderfrom kiota_abstractions.base_request_configuration import RequestConfiguration# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=pythonquery_params = MessagesRequestBuilder.MessagesRequestBuilderGetQueryParameters(orderby = ["from/emailAddress/address"],)request_configuration = RequestConfiguration(query_parameters = query_params,)result = await graph_client.me.messages.get(request_configuration = request_configuration)

To sort results in ascending or descending order, append eitherasc ordesc to the field name, separated by a space; for example,?$orderby=name desc (unencoded),?$orderby=name%20desc (URL encoded). If you don't specify the sort order, ascending order is inferred.

With some APIs, you can order results on multiple properties. For example, the following request orders the messages in the user's Inbox, first by the name of the person who sent it in descending order (Z to A), and then by subject in ascending order (default).

GET https://graph.microsoft.com/v1.0/me/mailFolders/Inbox/messages?$orderby=from/emailAddress/name desc,subject

// Code snippets are only available for the latest version. Current version is 5.x// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharpvar result = await graphClient.Me.MailFolders["{mailFolder-id}"].Messages.GetAsync((requestConfiguration) =>{requestConfiguration.QueryParameters.Orderby = new string []{ "from/emailAddress/name desc","subject" };});

// Code snippets are only available for the latest major version. Current major version is $v1.*// Dependenciesimport (  "context"  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"  graphusers "github.com/microsoftgraph/msgraph-sdk-go/users"  //other-imports)requestParameters := &graphusers.MailFoldersItemMessagesRequestBuilderGetQueryParameters{Orderby: [] string {"from/emailAddress/name desc","subject"},}configuration := &graphusers.MailFoldersItemMessagesRequestBuilderGetRequestConfiguration{QueryParameters: requestParameters,}// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=gomessages, err := graphClient.Me().MailFolders().ByMailFolderId("mailFolder-id").Messages().Get(context.Background(), configuration)

// Code snippets are only available for the latest version. Current version is 6.xGraphServiceClient graphClient = new GraphServiceClient(requestAdapter);MessageCollectionResponse result = graphClient.me().mailFolders().byMailFolderId("{mailFolder-id}").messages().get(requestConfiguration -> {requestConfiguration.queryParameters.orderby = new String []{"from/emailAddress/name desc", "subject"};});

const options = {authProvider,};const client = Client.init(options);let messages = await client.api('/me/mailFolders/Inbox/messages').orderby('from/emailAddress/name desc,subject').get();

<?phpuse Microsoft\Graph\GraphServiceClient;use Microsoft\Graph\Generated\Users\Item\MailFolders\Item\Messages\MessagesRequestBuilderGetRequestConfiguration;$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);$requestConfiguration = new MessagesRequestBuilderGetRequestConfiguration();$queryParameters = MessagesRequestBuilderGetRequestConfiguration::createQueryParameters();$queryParameters->orderby = ["from/emailAddress/name desc","subject"];$requestConfiguration->queryParameters = $queryParameters;$result = $graphServiceClient->me()->mailFolders()->byMailFolderId('mailFolder-id')->messages()->get($requestConfiguration)->wait();

Import-Module Microsoft.Graph.Mail# A UPN can also be used as -UserId.Get-MgUserMailFolderMessage -UserId $userId -MailFolderId $mailFolderId -Sort "from/emailAddress/name desc,subject"

# Code snippets are only available for the latest version. Current version is 1.xfrom msgraph import GraphServiceClientfrom msgraph.generated.users.item.mail_folders.item.messages.messages_request_builder import MessagesRequestBuilderfrom kiota_abstractions.base_request_configuration import RequestConfiguration# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=pythonquery_params = MessagesRequestBuilder.MessagesRequestBuilderGetQueryParameters(orderby = ["from/emailAddress/name desc","subject"],)request_configuration = RequestConfiguration(query_parameters = query_params,)result = await graph_client.me.mail_folders.by_mail_folder_id('mailFolder-id').messages.get(request_configuration = request_configuration)

Note

When you specify$filter, the service infers a sort order for the results. If you use both$orderby and$filter to get messages, because the server always infers a sort order for the results of a$filter, you mustspecify properties in certain ways.

The following example shows a query filtered by thesubject andimportance properties, and then sorted by thesubject,importance, andreceivedDateTime properties in descending order.

GET https://graph.microsoft.com/v1.0/me/messages?$filter=Subject eq 'welcome' and importance eq 'normal'&$orderby=subject,importance,receivedDateTime desc

// Code snippets are only available for the latest version. Current version is 5.x// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharpvar result = await graphClient.Me.Messages.GetAsync((requestConfiguration) =>{requestConfiguration.QueryParameters.Filter = "Subject eq 'welcome' and importance eq 'normal'";requestConfiguration.QueryParameters.Orderby = new string []{ "subject","importance","receivedDateTime desc" };});

// Code snippets are only available for the latest major version. Current major version is $v1.*// Dependenciesimport (  "context"  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"  graphusers "github.com/microsoftgraph/msgraph-sdk-go/users"  //other-imports)requestFilter := "Subject eq 'welcome' and importance eq 'normal'"requestParameters := &graphusers.ItemMessagesRequestBuilderGetQueryParameters{Filter: &requestFilter,Orderby: [] string {"subject","importance","receivedDateTime desc"},}configuration := &graphusers.ItemMessagesRequestBuilderGetRequestConfiguration{QueryParameters: requestParameters,}// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=gomessages, err := graphClient.Me().Messages().Get(context.Background(), configuration)

// Code snippets are only available for the latest version. Current version is 6.xGraphServiceClient graphClient = new GraphServiceClient(requestAdapter);MessageCollectionResponse result = graphClient.me().messages().get(requestConfiguration -> {requestConfiguration.queryParameters.filter = "Subject eq 'welcome' and importance eq 'normal'";requestConfiguration.queryParameters.orderby = new String []{"subject", "importance", "receivedDateTime desc"};});

const options = {authProvider,};const client = Client.init(options);let messages = await client.api('/me/messages').filter('Subject eq \'welcome\' and importance eq \'normal\'').orderby('subject,importance,receivedDateTime desc').get();

<?phpuse Microsoft\Graph\GraphServiceClient;use Microsoft\Graph\Generated\Users\Item\Messages\MessagesRequestBuilderGetRequestConfiguration;$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);$requestConfiguration = new MessagesRequestBuilderGetRequestConfiguration();$queryParameters = MessagesRequestBuilderGetRequestConfiguration::createQueryParameters();$queryParameters->filter = "Subject eq 'welcome' and importance eq 'normal'";$queryParameters->orderby = ["subject","importance","receivedDateTime desc"];$requestConfiguration->queryParameters = $queryParameters;$result = $graphServiceClient->me()->messages()->get($requestConfiguration)->wait();

Import-Module Microsoft.Graph.Mail# A UPN can also be used as -UserId.Get-MgUserMessage -UserId $userId -Filter "Subject eq 'welcome' and importance eq 'normal'" -Sort "subject,importance,receivedDateTime desc"

# Code snippets are only available for the latest version. Current version is 1.xfrom msgraph import GraphServiceClientfrom msgraph.generated.users.item.messages.messages_request_builder import MessagesRequestBuilderfrom kiota_abstractions.base_request_configuration import RequestConfiguration# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=pythonquery_params = MessagesRequestBuilder.MessagesRequestBuilderGetQueryParameters(filter = "Subject eq 'welcome' and importance eq 'normal'",orderby = ["subject","importance","receivedDateTime desc"],)request_configuration = RequestConfiguration(query_parameters = query_params,)result = await graph_client.me.messages.get(request_configuration = request_configuration)

Note

Combining$orderby and$filter query parameters is supported for directory objects. SeeAdvanced query capabilities on directory objects.

Search

Use the$search query parameter to restrict request results to match a search criterion. Its syntax and behavior varies across different resources. For more information, seeUse the $search query parameter to match a search criterion.

Select

Use the$select query parameter to return a subset of properties for a resource. With$select, you can specify a subset or a superset of the default properties.

When you make a GET request without using$select to limit the property data, Microsoft Graph includes a@microsoft.graph.tips property that provides a best practice recommendation for using$select similar to the following message:

"@microsoft.graph.tips": "Use $select to choose only the properties your app needs, as this can lead to performance improvements. For example: GET groups?$select=appMetadata,assignedLabels",

For example, when getting the messages of the signed-in user, you can specify that only thefrom andsubject properties be returned:

GET https://graph.microsoft.com/v1.0/me/messages?$select=from,subject

// Code snippets are only available for the latest version. Current version is 5.x// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharpvar result = await graphClient.Me.Messages.GetAsync((requestConfiguration) =>{requestConfiguration.QueryParameters.Select = new string []{ "from","subject" };});

// Code snippets are only available for the latest major version. Current major version is $v1.*// Dependenciesimport (  "context"  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"  graphusers "github.com/microsoftgraph/msgraph-sdk-go/users"  //other-imports)requestParameters := &graphusers.ItemMessagesRequestBuilderGetQueryParameters{Select: [] string {"from","subject"},}configuration := &graphusers.ItemMessagesRequestBuilderGetRequestConfiguration{QueryParameters: requestParameters,}// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=gomessages, err := graphClient.Me().Messages().Get(context.Background(), configuration)

// Code snippets are only available for the latest version. Current version is 6.xGraphServiceClient graphClient = new GraphServiceClient(requestAdapter);MessageCollectionResponse result = graphClient.me().messages().get(requestConfiguration -> {requestConfiguration.queryParameters.select = new String []{"from", "subject"};});

const options = {authProvider,};const client = Client.init(options);let messages = await client.api('/me/messages').select('from,subject').get();

<?phpuse Microsoft\Graph\GraphServiceClient;use Microsoft\Graph\Generated\Users\Item\Messages\MessagesRequestBuilderGetRequestConfiguration;$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);$requestConfiguration = new MessagesRequestBuilderGetRequestConfiguration();$queryParameters = MessagesRequestBuilderGetRequestConfiguration::createQueryParameters();$queryParameters->select = ["from","subject"];$requestConfiguration->queryParameters = $queryParameters;$result = $graphServiceClient->me()->messages()->get($requestConfiguration)->wait();

Import-Module Microsoft.Graph.Mail# A UPN can also be used as -UserId.Get-MgUserMessage -UserId $userId -Property "from,subject"

# Code snippets are only available for the latest version. Current version is 1.xfrom msgraph import GraphServiceClientfrom msgraph.generated.users.item.messages.messages_request_builder import MessagesRequestBuilderfrom kiota_abstractions.base_request_configuration import RequestConfiguration# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=pythonquery_params = MessagesRequestBuilder.MessagesRequestBuilderGetQueryParameters(select = ["from","subject"],)request_configuration = RequestConfiguration(query_parameters = query_params,)result = await graph_client.me.messages.get(request_configuration = request_configuration)

Important

We recommend that you use$select to limit the properties returned by a query to those needed by your app. This is especially true for queries that might potentially return a large result set. Limiting the properties returned in each row reduces network load and improves your app's performance.

Inv1.0, some Microsoft Entra resources that derive fromdirectoryObject, likeuser andgroup, return a limited, default subset of properties on reads. For these resources, you must use$select to return properties outside of the default set.

Skip

Use the$skip query parameter to set the number of items to skip at the start of a collection.For example, the following request returns events for the user sorted by date created, starting with the 21st event in the collection:

GET  https://graph.microsoft.com/v1.0/me/events?$orderby=createdDateTime&$skip=20

// Code snippets are only available for the latest version. Current version is 5.x// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharpvar result = await graphClient.Me.Events.GetAsync((requestConfiguration) =>{requestConfiguration.QueryParameters.Orderby = new string []{ "createdDateTime" };requestConfiguration.QueryParameters.Skip = 20;});

// Code snippets are only available for the latest major version. Current major version is $v1.*// Dependenciesimport (  "context"  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"  graphusers "github.com/microsoftgraph/msgraph-sdk-go/users"  //other-imports)requestSkip := int32(20)requestParameters := &graphusers.ItemEventsRequestBuilderGetQueryParameters{Orderby: [] string {"createdDateTime"},Skip: &requestSkip,}configuration := &graphusers.ItemEventsRequestBuilderGetRequestConfiguration{QueryParameters: requestParameters,}// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=goevents, err := graphClient.Me().Events().Get(context.Background(), configuration)

// Code snippets are only available for the latest version. Current version is 6.xGraphServiceClient graphClient = new GraphServiceClient(requestAdapter);EventCollectionResponse result = graphClient.me().events().get(requestConfiguration -> {requestConfiguration.queryParameters.orderby = new String []{"createdDateTime"};requestConfiguration.queryParameters.skip = 20;});

const options = {authProvider,};const client = Client.init(options);let events = await client.api('/me/events').orderby('createdDateTime').skip(20).get();

<?phpuse Microsoft\Graph\GraphServiceClient;use Microsoft\Graph\Generated\Users\Item\Events\EventsRequestBuilderGetRequestConfiguration;$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);$requestConfiguration = new EventsRequestBuilderGetRequestConfiguration();$queryParameters = EventsRequestBuilderGetRequestConfiguration::createQueryParameters();$queryParameters->orderby = ["createdDateTime"];$queryParameters->skip = 20;$requestConfiguration->queryParameters = $queryParameters;$result = $graphServiceClient->me()->events()->get($requestConfiguration)->wait();

Import-Module Microsoft.Graph.Calendar# A UPN can also be used as -UserId.Get-MgUserEvent -UserId $userId -Sort "createdDateTime" -Skip 20

# Code snippets are only available for the latest version. Current version is 1.xfrom msgraph import GraphServiceClientfrom msgraph.generated.users.item.events.events_request_builder import EventsRequestBuilderfrom kiota_abstractions.base_request_configuration import RequestConfiguration# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=pythonquery_params = EventsRequestBuilder.EventsRequestBuilderGetQueryParameters(orderby = ["createdDateTime"],skip = 20,)request_configuration = RequestConfiguration(query_parameters = query_params,)result = await graph_client.me.events.get(request_configuration = request_configuration)

Some Microsoft Graph APIs, like Outlook Mail and Calendars (message,event, andcalendar), use$skip to implement paging. When query results span multiple pages, these APIs return an@odata.nextLink property with a URL that contains a$skip parameter. You can use this URL to return the next page of results. To learn more, seePaging.

Directory objects such asuser,group, andapplication don't support$skip.

SkipToken

Some requests return multiple pages of data, either due to server-side paging or due to using the$top parameter to limit the page size of the response. Many Microsoft Graph APIs use theskipToken query parameter to reference subsequent pages of the result.
This parameter contains an opaque token that references the next page of results and is returned in the URL provided in the@odata.nextLink property in the response. To learn more, seePaging.

Note

If you're using OData Count (adding$count=true in the query string) for queries against directory objects, the@odata.count property is present only in the first page.

TheConsistencyLevel header required for advanced queries against directory objects isn't included by default in subsequent page requests. It must be set explicitly in subsequent pages.

Top

Use the$top query parameter to specify the number of items to be included in the result.

If more items remain in the result set, the response body contains an@odata.nextLink parameter. This parameter contains a URL that you can use to get the next page of results. To learn more, seePaging.

The minimum value of $top is 1 and the maximum depends on the corresponding API.

For example, the followinglist messages request returns the first five messages in the user's mailbox:

GET https://graph.microsoft.com/v1.0/me/messages?$top=5

// Code snippets are only available for the latest version. Current version is 5.x// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharpvar result = await graphClient.Me.Messages.GetAsync((requestConfiguration) =>{requestConfiguration.QueryParameters.Top = 5;});

// Code snippets are only available for the latest major version. Current major version is $v1.*// Dependenciesimport (  "context"  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"  graphusers "github.com/microsoftgraph/msgraph-sdk-go/users"  //other-imports)requestTop := int32(5)requestParameters := &graphusers.ItemMessagesRequestBuilderGetQueryParameters{Top: &requestTop,}configuration := &graphusers.ItemMessagesRequestBuilderGetRequestConfiguration{QueryParameters: requestParameters,}// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=gomessages, err := graphClient.Me().Messages().Get(context.Background(), configuration)

// Code snippets are only available for the latest version. Current version is 6.xGraphServiceClient graphClient = new GraphServiceClient(requestAdapter);MessageCollectionResponse result = graphClient.me().messages().get(requestConfiguration -> {requestConfiguration.queryParameters.top = 5;});

const options = {authProvider,};const client = Client.init(options);let messages = await client.api('/me/messages').top(5).get();

<?phpuse Microsoft\Graph\GraphServiceClient;use Microsoft\Graph\Generated\Users\Item\Messages\MessagesRequestBuilderGetRequestConfiguration;$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);$requestConfiguration = new MessagesRequestBuilderGetRequestConfiguration();$queryParameters = MessagesRequestBuilderGetRequestConfiguration::createQueryParameters();$queryParameters->top = 5;$requestConfiguration->queryParameters = $queryParameters;$result = $graphServiceClient->me()->messages()->get($requestConfiguration)->wait();

Import-Module Microsoft.Graph.Mail# A UPN can also be used as -UserId.Get-MgUserMessage -UserId $userId -Top 5

# Code snippets are only available for the latest version. Current version is 1.xfrom msgraph import GraphServiceClientfrom msgraph.generated.users.item.messages.messages_request_builder import MessagesRequestBuilderfrom kiota_abstractions.base_request_configuration import RequestConfiguration# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=pythonquery_params = MessagesRequestBuilder.MessagesRequestBuilderGetQueryParameters(top = 5,)request_configuration = RequestConfiguration(query_parameters = query_params,)result = await graph_client.me.messages.get(request_configuration = request_configuration)

Note

TheConsistencyLevel header required for advanced queries against directory objects isn't included by default in subsequent page requests. It must be set explicitly in subsequent pages.

Error handling for query parameters

Some requests return an error message if a specified query parameter isn't supported. For example, you can't use$expand on theuser/photo relationship.

https://graph.microsoft.com/v1.0/me?$expand=photo

{    "error":{        "code":"ExpandNotSupported",        "message":"Expand is not allowed for property 'Photo' according to the entity schema.",        "innerError":{            "request-id":"1653fefd-bc31-484b-bb10-8dc33cb853ec",            "date":"2017-07-31T20:55:01"        }    }}

However, sometimes query parameters specified in a request fail silently. For example, for unsupported query parameters and for unsupported combinations of query parameters. In these cases, examine the data returned by the request to determine whether the query parameters you specified had the desired effect.

Movatterモバイル変換

Share via

Customize Microsoft Graph responses with query parameters

In this article

OData system query options

Other query parameters

Other OData URL capabilities

Encoding query parameters

Escaping single quotes

Count

Expand

Filter

Format

OrderBy

Search

Select

Skip

SkipToken

Top

Error handling for query parameters

Related content

Feedback

Additional resources

In this article