# sobject describe

Display the metadata for a standard or custom object or a Tooling API object.

## Description for sobject describe

The metadata is displayed in JSON format. See this topic for a description of each property: <https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_calls_describesobjects_describesobjectresult.htm>.

This command displays metadata for Salesforce objects by default. Use the --use-tooling-api flag to view metadata for a Tooling API object.

## Aliases for sobject describe

`force:schema:sobject:describe`

## Flags

| Flag Name (Long)    | Flag Name (Short) | Description                                                                                                                                         |
| ------------------- | ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--api-version`     | N/A               | **Type:** Value<br><br>Override the api version used for api requests made by this command                                                          |
| `--flags-dir`       | N/A               | **Type:** Value<br><br>Import flag values from a directory.                                                                                         |
| `--json`            | N/A               | **Type:** Boolean<br><br>Format output as json.                                                                                                     |
| `--sobject`         | `-s`              | **Type:** Value<br>**Required**<br><br>API name of the object to describe.                                                                          |
| `--target-org`      | `-o`              | **Type:** Value<br>**Required**<br><br>Username or alias of the target org. Not required if the `target-org` configuration variable is already set. |
| `--use-tooling-api` | `-t`              | **Type:** Boolean<br><br>Use Tooling API to display metadata for Tooling API objects.                                                               |

## Examples for sobject describe

Display the metadata of the "Account" standard object in your default org:

```shell
sf sobject describe --sobject Account
```

Display the metadata of the "MyObject\_\_c" custom object in the org with alias "my-scratch-org":

```shell
sf sobject describe --sobject MyObject__c --target-org my-scratch-org
```

Display the metadata of the ApexCodeCoverage Tooling API object in your default org:

```shell
sf sobject describe --sobject ApexCodeCoverage --use-tooling-api
```