Required. The unique identifier of the brand. If the brand identifier is "1234", this parameter resolves to "brands/1234". The brand identifier must be "-" to return all agents for an RBM carrier.
Query parameters
Parameters
pageSize
integer
Specify the maximum number of results to be returned by the server. The server may further constrain the maximum number of results returned in a single page. If the pageSize is 0, the server will decide the number of results to be returned.
pageToken
string
The nextPageToken value returned from a previous List request, if any.
Request body
The request body must be empty.
Response body
A list of agents.
If successful, the response body contains data with the following structure:
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-11-14 UTC."],[[["\u003cp\u003eThis API endpoint retrieves a list of agents associated with a specific brand.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eparent\u003c/code\u003e path parameter is required and specifies the brand's unique identifier, or "-" to list all agents for an RBM carrier.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003epageSize\u003c/code\u003e query parameter is always set to 0 by this method, allowing the server to determine the number of results returned.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003enextPageToken\u003c/code\u003e query parameter allows for pagination through large result sets.\u003c/p\u003e\n"],["\u003cp\u003eThe response contains an array of \u003ccode\u003eagents\u003c/code\u003e objects and a \u003ccode\u003enextPageToken\u003c/code\u003e string for subsequent page requests.\u003c/p\u003e\n"]]],[],null,["# Method: brands.agents.list\n\nLists all the agents associated with a brand.\n\n\u003cbr /\u003e\n\n| **Note** : This method always sets `pageSize` to `0`.\n\n\u003cbr /\u003e\n\n### HTTP request\n\n`GET https://businesscommunications.googleapis.com/v1/{parent=brands/*}/agents`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `parent` | `string` Required. The unique identifier of the brand. If the brand identifier is \"1234\", this parameter resolves to \"brands/1234\". The brand identifier must be \"-\" to return all agents for an RBM carrier. |\n\n### Query parameters\n\n| Parameters ||\n|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` Specify the maximum number of results to be returned by the server. The server may further constrain the maximum number of results returned in a single page. If the pageSize is 0, the server will decide the number of results to be returned. |\n| `pageToken` | `string` The nextPageToken value returned from a previous List request, if any. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nA list of agents.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"agents\": [ { object (/business-communications/rcs-business-messaging/reference/business-communications/rest/v1/brands.agents#Agent) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `agents[]` | `object (`[Agent](/business-communications/rcs-business-messaging/reference/business-communications/rest/v1/brands.agents#Agent)`)` List of agent information. |\n| `nextPageToken` | `string` The pagination token to retrieve the next page of results. If the value is \"\", it means no further results for the request. |"]]