--- title: "Get a list of invites" method: GET path: "/channels/{id}/invites" tags: ["Endpoints"] --- # Get a list of invites `GET /channels/{id}/invites` This method retrieves the list of review invites by channel ID. The result set can be modified using a set of filters. The path must contain a `channelId`. Note that this must be the channel ID that was assigned by *eTrusted* and *not* a user-defined ID. Query parameters can be added to the request, separated by `&`. By adding parameters to the request, you can filter the result list and: * specify the maximum number of invites they want to retrieve with this request * retrieve invites submitted within a certain time frame The response object contains the list of invite objects as well as information for paginating invites in a user interface. See our guide on [paginating response data](https://developers.etrusted.com/etrusted-api.html#tag/Pagination) for more information. ## Path parameters - `id` string, required ## Query parameters - `count` integer - `after` string - `before` string - `query` string ## Headers - `token` string, required - `Channel-Id` string ## Response `200` The list of invites. - InviteResponseListDto - `totalElements` integer — This field has the default value of 0 and will be removed in the future cause backend compatibillity issue. - `paging` object — The paging object holds pagination information for the invites retrieved via this API. - `count` integer — The number of invites displayed in one page of the pagination. Note that this number might be lower than the `count` number in the request. This happens when the last page is reached. For example: A total number of 105 invites are displayed in chunks of 20 invites per page. The sixth and last page will only have 5 reviews. The `count` property will hold the value `5`. - `cursor` object — The cursor object contains information to navigate to the previous and next pages in a subsequent request. - `after` string — `after` is an invite UUID to retrieve the next page in the pagination. - `before` string — `before` is an invite UUID to retrieve the previous page in the pagination. - `links` object — Links to the previous and next pages in the pagination. Note that the links contain the same `query` filter parameters that was used in the request. This makes sure that the pagination is always relative to the same filter in subsequent requests. If you build URLs yourself using `after`, `before`, make sure that you recreate the same filter as well. - `previous` string — The link to the previous page in the pagination. - `next` string — The link to the next page in the pagination. - `items` InviteResponseDto[] — The list of invite objects. Each `item` object represents a single retrieved invite. - `id` string — The invite UUID. - `_object` string — The invite object type. - `mode` 'AUTOMATIC' | 'MANUAL' — The invite mode. Automatic invites are triggered by invite rules, while manual invites are triggered manually (e.g. in the Control Centre). - `reviewType` 'SERVICE_REVIEW' | 'PRODUCT_REVIEW' | 'SERVICE_AND_PRODUCT_REVIEW' — The type of review the invitation asks for. The invite has been sent asking for feedback either about the service, the transaction's products or for both. - `accountRef` string — A UUID as account reference. - `channelRef` string — A UUID as channel reference. - `locale` string, locale — The channel [locale](#tag/Locales) that determines the language that is used for this channel. - `platform` string — Represents the name of an external review platform. - `customer` object — The data of the customer who is invited to the review. - `id` string — The customer UUID. - `firstName` string — First name of the customer. - `lastName` string — Last name of the customer. - `email` string — Email address of the customer. This must be a valid email address. - `phoneNumber` string — A phone number in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en). - `preferredLocale` string — The preferred locale for this customer. - `consents` object[] — This is an array of consent objects for the customer. - `purpose` string — The purpose of the consent. This indicates what may and may not be done with the personal data of the customer. As of yet, this property can only have the value `DATA_FORWARDING`. - `given` boolean — This boolean value indicates whether a consent was given or not. - `inviteSource` string — The source system that triggered the invite. This property can have the following values: - `TRUSTBADGE` - `IMPORTER` - `APP_IOS` - `APP_ANDROID` - `REVIEW_COLLECTOR` - `CUSTOM` - `transaction` object — The transaction associated with the invite. - `id` string — The transaction UUID. - `reference` string — The transaction reference, e.g. `ORDER-12345`. - `date` string, date-time — The date and time when the transaction took place, in the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) and [RFC 3339](https://tools.ietf.org/html/rfc3339) compliant format `yyyy-MM-dd’T’HH:mm:ss.SSSZ`. - `scheduledAt` string, date-time — The date and time when the transaction was scheduled, in the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) and [RFC 3339](https://tools.ietf.org/html/rfc3339) compliant format `yyyy-MM-dd’T’HH:mm:ss.SSSZ`. - `estimatedDeliveryDate` string, date — The estimated date of the delivery. It is a date in the ISO 8601 and RFC3339 compliant format `yyyy-MM-dd`. - `template` TemplateDto — The template used for generating the questionnaire for the invite. - `id` string — A reference to the template used for generating the questionnaire. - `name` string — The title of the questionnaire. - `sender` EmailDto — Email data for identifying a customer or an organisation by email address. - `name` string — The customer's or organisation's name. - `email` string — The email address. - `replyTo` EmailDto — Email data for identifying a customer or an organisation by email address. - `name` string — The customer's or organisation's name. - `email` string — The email address. - `event` string — A UUID as event reference. - `createdAt` string, date-time — The date and time when the invite was created, in the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) and [RFC 3339](https://tools.ietf.org/html/rfc3339) compliant format `yyyy-MM-dd’T’HH:mm:ss.SSSZ`. - `updatedAt` string, date-time — The date and time when the invite was last modified, in the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) and [RFC 3339](https://tools.ietf.org/html/rfc3339) compliant format `yyyy-MM-dd’T’HH:mm:ss.SSSZ`. - `sentAt` string, date-time — The date and time when the invite was sent to the customer, in the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) and [RFC 3339](https://tools.ietf.org/html/rfc3339) compliant format `yyyy-MM-dd’T’HH:mm:ss.SSSZ`. - `status` object — Status information of the invite when the API request was processed. See our [glossary entry for invites](https://developers.etrusted.com/glossary.html#invite) for more information about the statuses. - `name` 'SCHEDULED' | 'CANCELED' | 'SENT' | 'DELIVERED' | 'NOT_DELIVERED' | 'REJECTED' | 'OPENED' | 'CLICKED' | 'RENDERED' | 'REVIEW_WRITTEN' | 'READY_FOR_RENDER', required — The invite state. - `reason` 'INVALID_TEMPLATE' | 'RENDERING_ERROR' | 'INVALID_RECIPIENT_EMAIL' | 'TEMPORARY_RECIPIENT_ERROR' | 'REPORTED_AS_SPAM_SENDER' | 'REPORTED_AS_SPAM_RECIPIENT' | 'REPORTED_AS_SPAM_CONTENT' | 'REPORTED_AS_SPAM_FREQUENCY' | 'PROVIDER_ERROR' | 'DELAYED' | 'RECIPIENT_UNSUBSCRIBED' | 'RECIPIENT_BLACKLISTED_PROVIDER' | 'RECIPIENT_BLACKLISTED_ACCOUNT' | 'RECIPIENT_BLACKLISTED_CHANNEL' | 'RECIPIENT_BLACKLISTED_EMAIL' | 'BLACKLISTED_DOMAIN' | 'DUPLICATE' | 'INVITE_SENDING_SUSPENDED_BY_EMPLOYEE' | 'INVITE_SENDING_SUSPENDED_BY_CUSTOMER' | 'INTERNAL_ERROR' | 'BLOCKED_BY_CONSUMER' — The reason for the invite state. ## Other responses - `401` — Unauthorized - `403` — Forbidden - `404` — Not Found --- [API](https://skmtc.net/etrusted/apis/accounts-api.md) · [All operations](https://skmtc.net/etrusted/apis/accounts-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/etrusted/accounts-api/versions/649ef7dac98c/schema)