v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB

Custom Entity

CustomEntities.get

Returns CustomEntity with given id

get/entities/{custom_entity_api_name}/{id}

Path parameters

custom_entity_api_namestring required

Custom entity api name

idstring uuid required

ID of CustomEntity to retrieve

Response

CustomEntity data

successboolean

True when response 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",
    "currency_exchange_rates_list_id": "01234567-abcd-dcba-ffff-000000000000",
    "name": "string",
    "owner_id": "01234567-abcd-dcba-ffff-000000000000",
    "table_name": "string",
    "type_id": "01234567-abcd-dcba-ffff-000000000000",
    "unit_id": "01234567-abcd-dcba-ffff-000000000000",
    "revision": 1
  }
}