---
title: "Get folder details"
method: POST
path: "/crm/schema/getfolder/"
tags: ["CRM (Schema)"]
---

# Get folder details

`POST /crm/schema/getfolder/`

## Headers

- `Content-Language` unknown

## Request body

- OfficeGuyAppsCRMMVCAPISchemaControllerSchemaGetFolderRequest
  - `Credentials` CoreAPICredentials, required
    - `CompanyID` integer, required — Company identifier
    - `APIKey` string, required — API key secret
  - `Folder` string, required — Folder identifier. Can be either application folder name, or FolderID.
  - `IncludeProperties` boolean, nullable — Get folder properties Defaults to False

## Response `200`

OK

- ResponseOfficeGuyAppsCRMMVCAPISchemaControllerSchemaGetFolderResponse
  - `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` OfficeGuyAppsCRMMVCAPISchemaControllerSchemaGetFolderResponse
    - `Folder` OfficeGuyAppsCRMMVCAPITypedFolder
      - `ID` integer
      - `Name` string, nullable
    - `Properties` OfficeGuyAppsCRMMVCAPITypedProperty[], nullable
      - `ID` integer
      - `Name` string, nullable
      - `Description` string, nullable
      - `Category` string, nullable
      - `ValueType` string, nullable
      - `APIName` string, nullable
      - `Required` boolean

---

[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/de2902289b3a/schema)