# Retrieve websites

Retrieves a list of websites.

Endpoint: GET /websites
Version: latest
Security: SecretApiKey, JWT, ApplicationJWT

## Query parameters:

  - `limit` (integer)
    Limits the number of collection items to be returned.

  - `offset` (integer)
    Specifies the starting point within the collection of items to be returned.

  - `q` (string)
    Use this field to perform a partial search of text fields.

  - `filter` (string)
    Filters the collection items. This field requires
a special format. Use  for multiple allowed values.  Use  for multiple fields.

For more information, see
Using filter with collections.

  - `sort` (array)
    Sorts and orders the collection of items. To sort in descending
order, prefix with . Multiple fields can be sorted by separating each with .

## Response 200 fields (application/json):

  - `id` (string)
    ID of the website.
A website is where an organization obtains a customer.
For more information, see [Obtain an organization ID and website ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).
    Example: "web_0YV7DE4Z26DQSA1AC92FBJ7SEG"

  - `name` (string, required)
    Name of the website.

  - `url` (string, required)
    Domain address of the website.

  - `servicePhone` (string, required)
    Customer service phone number of the website.

  - `serviceEmail` (string, required)
    Customer service email address of the website.

  - `createdTime` (string)
    Date and time which is set automatically when the resource is created.

  - `updatedTime` (string)
    Date and time which updates automatically when the resource is updated.

  - `customFields` (object)
    Use custom fields to extend a resource scheme to include custom data that is not provided as a common field.
For more information, see [Custom fields](https://www.rebilly.com/catalog/all/custom-fields).
    Example: {"foo":"bar"}

  - `settings` (object)
    Website settings.

  - `settings.depositForm` (object)
    Deposit form settings.

  - `settings.depositForm.theme` (object,null)
    Theme settings that are used in the deposit form.

  - `settings.depositForm.theme.colorPrimary` (string,null)
    Primary color for the deposit form in hexadecimal format.
    Example: "0044d4"

  - `settings.depositForm.theme.colorSecondary` (string,null)
    Secondary color for the deposit form in hexadecimal format.
    Example: "ffffff"

  - `settings.depositForm.theme.buttonTemplate` (string,null)
    Submit button template.  can be used as a placeholder for amount and currency.
    Example: "Pay {{amount}}"

  - `settings.paymentForm` (object)
    Payment form settings.

  - `settings.paymentForm.css` (string,null)
    Hosted payment form [CSS options](https://www.rebilly.com/docs/content/concepts-and-features/tutorial/customize-style-rebilly-instruments/#2-use-css-property-to-override-any-styles).

  - `settings.paymentForm.theme` (object,null)
    Hosted payment form [theme options](https://www.rebilly.com/docs/content/concepts-and-features/tutorial/customize-style-rebilly-instruments/#adjust-the-default-style).
    Example: {"colorPrimary":"#504CCA"}

  - `settings.paymentForm.features` (object,null)
    Hosted payment form features.

  - `settings.paymentForm.features.showCoupons` (array,null)

  - `settings.paymentForm.features.fullPageRedirect` (boolean,null)
    Specifies whether the hosted payment form uses a full page redirect, or the default iframe modal, for approval URL redirects.

  - `settings.paymentForm.features.skipRedirectOnPaymentComplete` (boolean,null)
    Specifies whether the hosted payment form skips the redirect to the website URL when the payment is completed.

  - `settings.paymentForm.features.hideZeroAmountSummaryItems` (boolean,null)
    Specifies whether the hosted payment form displays 0 amount line items in the summary.

  - `settings.amplitude` (object)
    Amplitude settings. Amplitude is an analytics tool for tracking user behavior.

  - `settings.amplitude.tracking` (boolean)
    Specifies whether the hosted pages, such as KYC pages, include Amplitude analytics.

  - `settings.amplitude.apiKey` (string,null)
    API key of an Amplitude project.
    Example: "35d1795750c585984f7e6b01c0ca6e19"

  - `logoId` (string,null)
    ID of the linked file object.
    Example: "4f6cf35x-2c4y-483z-a0a9-158621f77a21"

  - `logoUrl` (string,null)
    URL of the website logo.

  - `_links` (array)
    Related links.

  - `_links.href` (string)
    Link URL.

  - `_links.rel` (string)
    Type of link.
    Enum: "self", "logoUrl"

  - `organizationId` (string)
    Unique organization identifier.
An organization is an entity that represents a company.
For more information, see [Obtain an organization ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).
    Example: "org_0YVDM8RC7GDADADSBSMW124JA8"

## Response 401 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.

## Response 403 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.