Custom Entity

CustomEntities.get

Returns the CustomEntity record with the given id.

get/entities/{custom_entity_api_name}/{id}

Request

Base URL
https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id
Auth
HTTP basic
TypeScript
https://skmtc.dev/coevera/apis/coevera-crm-api/docs/entities/:custom_entity_api_name/:id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

custom_entity_api_namestring required

API name of the custom entity whose records to work with.

idstring uuid required

Id of the CustomEntity 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 CustomEntity 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",
    "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
  }
}

Changes

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