---
title: "Describe an object"
method: GET
path: "/v1/describe/{object}"
tags: ["Describe"]
---

# Describe an object

`GET /v1/describe/{object}`

Provides a reference listing of each object that is available in your Zuora tenant.

The information returned by this call is useful if you are using [CRUD: Create Export](https://developer.zuora.com/api-references/api/operation/Object_POSTExport) or the [AQuA API](https://knowledgecenter.zuora.com/DC_Developers/T_Aggregate_Query_API) to create a data source export. See [Export ZOQL](https://knowledgecenter.zuora.com/DC_Developers/M_Export_ZOQL) for more information.

### Response
The response contains an XML document that lists the fields of the specified object. Each of the object's fields is represented by a `<field>` element in the XML document.

 
Response sample:
```xml
<?xml version="1.0" encoding="UTF-8"?>
<object>
  <name>ProductRatePlanCharge</name>
  <label>Product Rate Plan Charge</label>
  <fields>
    ...
    <field>
      <name>TaxMode</name>
      <label>Tax Mode</label>
      <type>picklist</type>
      <options>
        <option>TaxExclusive</option>
        <option>TaxInclusive</option>
      </options>
      <contexts>
        <context>export</context>
      </contexts>
      ...
    </field>
    ...
  </fields>
</object>
```


It is strongly recommended that your integration checks `<contexts>` elements in the response. If your integration does not check `<contexts>` elements, your integration may process fields that are not available for use in data source exports. See [Changes to the Describe API](https://knowledgecenter.zuora.com/DC_Developers/M_Export_ZOQL/Changes_to_the_Describe_API) for more information.

## Path parameters

- `object` string, required

## Query parameters

- `showCurrencyConversionInformation` string
- `showRelationships` boolean

## Headers

- `Accept-Encoding` string
- `Content-Encoding` string
- `Zuora-Track-Id` string
- `Zuora-Entity-Ids` string
- `Zuora-Org-Ids` string
- `Zuora-Version` string

## Response `200`

Returns an XML document that lists the fields of the specified object.

## Other responses

- `404` — Returns an XML document that indicates the error
- `500` — Internal Server Error

---

[API](https://skmtc.dev/zuora/apis/api-reference.md) · [All operations](https://skmtc.dev/zuora/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zuora/api-reference/revisions/702f3caf3985/schema)