---
title: "Get entity"
method: POST
path: "/crm/data/getentity/"
tags: ["CRM (Data)"]
---

# Get entity

`POST /crm/data/getentity/`

## Headers

- `Content-Language` unknown

## Request body

- OfficeGuyAppsCRMMVCAPIDataControllerDataGetEntityRequest
  - `Credentials` CoreAPICredentials, required
    - `CompanyID` integer, required — Company identifier
    - `APIKey` string, required — API key secret
  - `EntityID` integer, required — Entities identifier
  - `IncludeIncomingProperties` boolean, nullable — Include incoming entity properties Defaults to False
  - `IncludeFields` boolean, nullable — Include all entity fields Defaults to True

## Response `200`

OK

- ResponseOfficeGuyAppsCRMMVCAPIDataControllerDataGetEntityResponse
  - `Status` 'Success (0)' | 'BusinessError (1)' | 'TechnicalError (2)'
  - `UserErrorMessage` string, nullable — Error message, in a user readable format
  - `TechnicalErrorDetails` string, nullable — Technical error details, let us know if you received this.
  - `Data` OfficeGuyAppsCRMMVCAPIDataControllerDataGetEntityResponse
    - `Entity` CoreTypedEntity
      - `ID` integer, nullable — SUMIT identifier Leave empty to create a new entity or search by other fields when applicable
      - `Folder` string, nullable — Folder identifier. Can be either application folder name, or FolderID.
      - `Properties` object, nullable — Entity fields

---

[API](https://skmtc.net/myofficeguy/apis/sumit-api-full.md) · [All operations](https://skmtc.net/myofficeguy/apis/sumit-api-full/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/myofficeguy/sumit-api-full/versions/2691e6cffa0c/schema)