/
Retrieve a custom deposit...

Retrieve a custom deposit property set
Experimental

Request

Retrieves a custom deposit property set with a specified ID.

Security
SecretApiKey or JWT
Path
idstring, <= 50 characters^[@~\-\.\w]+$required

ID of the resource.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/deposit-custom-property-sets/{id}' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

Custom deposit property set retrieved.

Bodyapplication/json
idstring, <= 50 charactersread-only

ID of the deposit property set.

Example:"dep_prop_0YVJ640MB4CXVB8KXBRW3B79R9"
namestringrequired

Name of the custom property set.

propertiesobjectrequired

Defines properties the user can complete when they use the hosted deposit form. This field accepts JSON-schema drafts 4, 6, and 7. Accepted properties types are: string, number, integer, array, and enum. For more information, see Configure custom hosted deposit properties.

Example:
{
  "type": "object",
  "properties": {
    "email": { … },
    "max": { … }
  },
  "required": [
    "email"
  ]
}
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.

Response
{
  "id": "dep_prop_0YVJ640MB4CXVB8KXBRW3B79R9",
  "name": "string",
  "properties": {
    "type": "object",
    "properties": { … },
    "required": [ … ]
  },
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedTime": "2019-08-24T14:15:22Z",
  "_links": [
    { … }
  ]
}