---
title: useExtensionApi()
description: |-
  Returns the full API object that was passed in to your extension when it was created.
  Depending on the extension target, this object can contain different properties.

  For example, the `purchase.checkout.cart-line-item.render-after` extension target will return the [CartLineDetailsApi](/docs/api/checkout-ui-extensions/apis/cartlinedetailsapi) object.
  Other targets may only have access to the [StandardApi](/docs/api/checkout-ui-extensions/apis/standardapi) object,
  which contains a basic set of properties about the checkout.

  For a full list of the API available to each extension target, see the [ExtensionTargets type](/docs/api/checkout-ui-extensions/apis/extensiontargets).

  > Caution: This is deprecated, use `useApi` instead.
api_version: 2024-01
api_name: checkout-ui-extensions
source_url:
  html: https://shopify.dev/docs/api/checkout-ui-extensions/2024-01/apis/useextensionapi()
  md: https://shopify.dev/docs/api/checkout-ui-extensions/2024-01/apis/useextensionapi().md
---

# use​Extension​Api()

Returns the full API object that was passed in to your extension when it was created. Depending on the extension target, this object can contain different properties.

For example, the `purchase.checkout.cart-line-item.render-after` extension target will return the [CartLineDetailsApi](https://shopify.dev/docs/api/checkout-ui-extensions/apis/cartlinedetailsapi) object. Other targets may only have access to the [StandardApi](https://shopify.dev/docs/api/checkout-ui-extensions/apis/standardapi) object, which contains a basic set of properties about the checkout.

For a full list of the API available to each extension target, see the [ExtensionTargets type](https://shopify.dev/docs/api/checkout-ui-extensions/apis/extensiontargets).

**Caution:** This is deprecated, use \<code>\<span class="PreventFireFoxApplyingGapToWBR">use\<wbr/>Api\</span>\</code> instead.

## use​Extension​Api()

### Returns

* **ApiForRenderExtension\<Target>**

### ApiForRenderExtension

For a given rendering extension target, returns the type of the API that the extension will receive at runtime. This API type is the second argument to the callback for that extension target. The first callback for all of the rendering extension targets each receive a \`RemoteRoot\` object.

```ts
ApiForRenderExtension<Target>
```

Examples

### Examples

* #### Accessing Properties

  ##### Description

  The extension API is passed as a parameter to the extension target function. In React, you can access it from any component through the \`useExtensionApi()\` hook.

  ##### React

  ```jsx
  import {
    reactExtension,
    Text,
    useExtensionApi,
  } from '@shopify/ui-extensions-react/checkout';

  export default reactExtension(
    'purchase.checkout.block.render',
    () => <Extension />,
  );

  function Extension() {
    const {shop} = useExtensionApi();
    return <Text>Shop name: {shop.name}</Text>;
  }
  ```

## Related

[Reference - Targets](https://shopify.dev/docs/api/checkout-ui-extensions/targets)

[Reference - Components](https://shopify.dev/docs/api/checkout-ui-extensions/components)

[Reference - Configuration](https://shopify.dev/docs/api/checkout-ui-extensions/configuration)

[Learn - Tutorials](https://shopify.dev/apps/checkout)