Method: loyaltyobject.list
Stay organized with collections
Save and categorize content based on your preferences.
Returns a list of all loyalty objects for a given issuer ID.
HTTP request
GET https://walletobjects.googleapis.com/walletobjects/v1/loyaltyObject
The URL uses gRPC Transcoding syntax.
Query parameters
| Parameters |
classId |
string
The ID of the class whose objects will be listed.
|
token |
string
Used to get the next set of results if maxResults is specified, but more than maxResults objects are available in a list. For example, if you have a list of 200 objects and you call list with maxResults set to 20, list will return the first 20 objects and a token. Call list again with maxResults set to 20 and the token to get the next 20 objects.
|
maxResults |
integer
Identifies the max number of results returned by a list. All results are returned if maxResults isn't defined.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
| Fields |
resources[] |
object (LoyaltyObject)
Resources corresponding to the list request.
|
pagination |
object (Pagination)
Pagination of the response.
|
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/wallet_object.issuer
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-13 UTC.
[null,null,["Last updated 2025-03-13 UTC."],[[["\u003cp\u003eThis endpoint retrieves all loyalty objects for a specified issuer ID using a GET request.\u003c/p\u003e\n"],["\u003cp\u003eRequest parameters include \u003ccode\u003eclassId\u003c/code\u003e, \u003ccode\u003etoken\u003c/code\u003e, and \u003ccode\u003emaxResults\u003c/code\u003e to filter and paginate results.\u003c/p\u003e\n"],["\u003cp\u003eThe response includes an array of loyalty objects and pagination details in JSON format.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization requires the \u003ccode\u003ehttps://www.googleapis.com/auth/wallet_object.issuer\u003c/code\u003e scope.\u003c/p\u003e\n"]]],["This outlines retrieving a list of loyalty objects associated with a specific issuer ID via a `GET` HTTP request to a defined URL. The request uses query parameters like `classId`, `token` for pagination, and `maxResults` to limit the returned items. The request body is empty. The successful response includes an array of `LoyaltyObject` resources and pagination details, formatted in JSON. Access requires `https://www.googleapis.com/auth/wallet_object.issuer` authorization scope.\n"],null,["# Method: loyaltyobject.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.LoyaltyObjectListResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n\nReturns a list of all loyalty objects for a given issuer ID.\n\n### HTTP request\n\n`GET https://walletobjects.googleapis.com/walletobjects/v1/loyaltyObject`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|--------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `classId` | `string` The ID of the class whose objects will be listed. |\n| `token` | `string` Used to get the next set of results if `maxResults` is specified, but more than `maxResults` objects are available in a list. For example, if you have a list of 200 objects and you call list with `maxResults` set to 20, list will return the first 20 objects and a token. Call list again with `maxResults` set to 20 and the token to get the next 20 objects. |\n| `maxResults` | `integer` Identifies the max number of results returned by a list. All results are returned if `maxResults` isn't defined. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"resources\": [ { object (/wallet/reference/rest/v1/loyaltyobject#LoyaltyObject) } ], \"pagination\": { object (/wallet/reference/rest/v1/Pagination) } } ``` |\n\n| Fields ||\n|---------------|----------------------------------------------------------------------------------------------------------------------------------|\n| `resources[]` | `object (`[LoyaltyObject](/wallet/reference/rest/v1/loyaltyobject#LoyaltyObject)`)` Resources corresponding to the list request. |\n| `pagination` | `object (`[Pagination](/wallet/reference/rest/v1/Pagination)`)` Pagination of the response. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/wallet_object.issuer`"]]
