Retrieve a website

Retrieve a website. Use it to find the website name, logo, or more.

SecurityCustomerJWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

Resource identifier string.

Responses
200

Website was retrieved.

Response Schema: application/json
name
required
string

Name of the website.

url
required
string

Domain address of the website.

servicePhone
required
string

Customer service phone number of the website.

serviceEmail
required
string <email>

Customer service email address of the website.

id
string <= 50 characters

Unique website identifier string.

createdTime
string <date-time>

Date and time at which the website was created.

updatedTime
string <date-time> (UpdatedTime)

Read-only timestamp. This value updates when the resource is updated.

customFields
object (ResourceCustomFields)
Default: {}

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.

object (WebsiteSettings)

Website settings.

object

Payment form settings.

css
object

Hosted payment form features.

organizationId
string <= 50 characters
Deprecated

Organization ID.

Array of Self (object) or OrganizationLink (object) non-empty

Related resource links.

Array (non-empty)
Any of:
href
required
string

Link URL.

rel
required
string

Type of link.

Value: "self"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

get/websites/{id}
Request samples
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "name": "string",
  • "url": "string",
  • "servicePhone": "string",
  • "serviceEmail": "user@example.com",
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "customFields": {
    },
  • "settings": {
    },
  • "organizationId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "_links": [
    ]
}