---
title: useApi
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).
api_version: 2023-07
api_name: checkout-ui-extensions
source_url:
  html: >-
    https://shopify.dev/docs/api/checkout-ui-extensions/2023-07/react-hooks/utilities/useapi
  md: >-
    https://shopify.dev/docs/api/checkout-ui-extensions/2023-07/react-hooks/utilities/useapi.md
---

# use​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).

## use​Api([\_target](#-propertydetail-target)​)

### Parameters

* \_target

  Target

### 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 \`useApi()\` hook.

  ##### React

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

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

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

## Related

[APIs - StandardApi](https://shopify.dev/docs/api/checkout-ui-extensions/apis/standardapi)

[APIs - CheckoutApi](https://shopify.dev/docs/api/checkout-ui-extensions/apis/checkoutapi)

[APIs - OrderStatusApi](https://shopify.dev/docs/api/checkout-ui-extensions/apis/orderstatusapi)

[APIs - CartLineItemApi](https://shopify.dev/docs/api/checkout-ui-extensions/apis/cartlineitemapi)

[APIs - PickupPointListApi](https://shopify.dev/docs/api/checkout-ui-extensions/apis/pickuppointlistapi)

[APIs - PickupLocationListApi](https://shopify.dev/docs/api/checkout-ui-extensions/apis/pickuplocationlistapi)

[APIs - ShippingOptionItemApi](https://shopify.dev/docs/api/checkout-ui-extensions/apis/shippingoptionitemapi)

[APIs - ExtensionTargets](https://shopify.dev/docs/api/checkout-ui-extensions/apis/extensiontargets)