# GET /api/hostedpaymentpages

List hosted payment pages

Retrieves a paginated list of hosted payment pages with optional filtering.

**Operation ID:** `GET_api_hostedpaymentpages`

## Authorization

Requires: HostedPaymentPage.HostedPaymentPages, merchant scope.

Required permissions:
- `HostedPaymentPage.HostedPaymentPages`

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| MaxCreationTime | query | no | string(date-time) |  |
| MinCreationTime | query | no | string(date-time) |  |
| MaxModifitionTime | query | no | string(date-time) |  |
| MinModifitionTime | query | no | string(date-time) |  |
| PagePurpose | query | no | PhoenixSharedModelsHostedPaymentPageHppPagePurpose | Optional server-side filter on the page's effective Phoenix.SharedModels.HostedPaymentPage.HppPagePurpose. When set,  only pages whose resolved purpose (null resolves to Phoenix.SharedModels.HostedPaymentPage.HppPagePurpose.Payment)  equals this value are returned. Used by purpose-scoped candidate lookups (e.g. the reseller  billing-preferences card-capture HPP picker, which must only ever surface  Phoenix.SharedModels.HostedPaymentPage.HppPagePurpose.SaveCard pages) so a caller cannot retrieve a non-matching page  through that path. `null` leaves the result unfiltered by purpose. |
| Filter | query | no | string | Gets or sets a general filter string for the result set. |
| Name | query | no | string | Gets or sets the name filter for the result set. |
| IncludeDeleted | query | no | boolean | Gets or sets a value indicating whether to include deleted entities in the result set. |
| IncludeInactive | query | no | boolean | Gets or sets a value indicating whether to include inactive entities in the result set. |
| Ids | query | no | array<string(uuid)> | Gets or sets a list of entity IDs to filter the result set. |
| Sorting | query | no | string |  |
| SkipCount | query | no | integer(int32) |  |
| MaxResultCount | query | no | integer(int32) |  |
| ExtraProperties | query | no | object |  |
| suppressNulls | query | no | boolean | If true, omit properties with null values. |

## Responses

### 200

OK

**Content type:** `text/plain`

Schema: `WinkPGApplicationDtosPagedResultDtoOfPhoeniXGateHostedPaymentPageHostedPaymentPageDto`

**Content type:** `application/json`

Schema: `WinkPGApplicationDtosPagedResultDtoOfPhoeniXGateHostedPaymentPageHostedPaymentPageDto`

**Content type:** `text/json`

Schema: `WinkPGApplicationDtosPagedResultDtoOfPhoeniXGateHostedPaymentPageHostedPaymentPageDto`

### 403

Forbidden

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `application/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `text/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 401

Unauthorized

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `application/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `text/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 400

Bad Request

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `application/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `text/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 404

Not Found

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `application/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `text/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 501

Not Implemented

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `application/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `text/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 500

Internal Server Error

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `application/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `text/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### default

The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. See the error-code reference in this document's description for the values `error.code` can take.

**Content type:** `application/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

## See also

- [All documentation](https://docs.winkpg.io/llms.txt): the machine-readable index of every public page on this site.