COcoevera
Interface

InterfacePreviews.get

Returns the InterfacePreview record with the given id.

get/entities/InterfacePreviews/{id}

Request

Path parameters

idstring uuid required

Id of the InterfacePreview record to retrieve.

Query parameters

expandstring

Related records to return inline instead of their URIs, comma-separated; dots reach nested relations. The only parameter this call accepts.

Response

The InterfacePreview record.

successboolean

True when the request succeeded; false on error.

Example response

{
  "success": true,
  "data": {
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "account_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "appointment_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "contact_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "custom_entity_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "lead_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "oppty_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "product_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "project_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "quote_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "settings": "blob",
    "task_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "revision": 1,
    "entity_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "entity_type": 1
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.