Retrieve websites

Request

Retrieves a list of websites.
Security
SecretApiKey or JWT or ApplicationJWT
Query
limitinteger, [ 0 .. 1000 ]

Limit the number of collection items to be returned. Use 0 to return an empty collection and still receive the count of matching items in Pagination-Total.

offsetinteger, [ 0 .. 1000 ]
Specifies the starting point within the collection of items to be returned.
qstring
Use this field to perform a partial search of text fields.
filterstring

Criteria for filtering collection items. This field requires a special format. Use , to specify multiple allowed values. Use ; to specify multiple fields.

For more information, see Search filters.

sortArray of strings

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

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/websites?limit=0&offset=0&q=string&filter=string&sort=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

List of websites retrieved.
Headers
Pagination-Totalinteger

Total number of items that match the request. The value is independent of limit, including when limit is 0.

Example:332
Pagination-Limitinteger
Maximum number of items per page.
Example:100
Pagination-Offsetinteger

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example:2
Bodyapplication/json
Array [
idstring, <= 50 characters(WebsiteId)read-only
Example:"web_0YV7DE4Z26DQSA1AC92FBJ7SEG"
namestringrequired
Name of the website.
urlstringrequired
Domain address of the website.
servicePhonestringrequired
Customer service phone number of the website.
serviceEmailstring, (email)required
Customer service email address of the website.
createdTimestring, (date-time)(CreatedTime)read-only
Date and time when the resource is created. This value is set automatically when the resource is created.
updatedTimestring, (date-time)(UpdatedTime)read-only
Date and time when the resource is updated. This value is set automatically when the resource is updated.
customFieldsobject(ResourceCustomFields)

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.

Default:{}
Example:
{
  "foo": "bar"
}
settingsobject
Website settings.
logoIdstring or null, <= 50 characters
ID of the linked file object.
Example:"4f6cf35x-2c4y-483z-a0a9-158621f77a21"
logoUrlstring or nullread-only
URL of the website logo.
_linksArray of objectsread-only
Related links.
organizationIdstring, <= 50 characters(OrganizationId)read-onlydeprecated

Unique organization identifier. An organization is an entity that represents a company. For more information, see Obtain an organization ID.

Example:"org_0YVDM8RC7GDADADSBSMW124JA8"
]
Response
[
  {
    "id": "web_0YV7DE4Z26DQSA1AC92FBJ7SEG",
    "name": "string",
    "url": "string",
    "servicePhone": "string",
    "serviceEmail": "user@example.com",
    "createdTime": "2019-08-24T14:15:22Z",
    "updatedTime": "2019-08-24T14:15:22Z",
    "customFields": { … },
    "settings": { … },
    "logoId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
    "logoUrl": "string",
    "organizationId": "org_0YVDM8RC7GDADADSBSMW124JA8",
    "_links": [ … ]
  }
]