# PlansApi

All URIs are relative to *http://localhost*

| Method | HTTP request | Description |
|------------- | ------------- | -------------|
| [**listPlans**](PlansApi.md#listplans) | **GET** /fna/api/v2/plans |  |



## listPlans

> PlansListPlansResponse listPlans(clientExternalUuid)



### Example

```ts
import {
  Configuration,
  PlansApi,
} from '@equisoft/equisoft-plan-sdk-typescript';
import type { ListPlansRequest } from '@equisoft/equisoft-plan-sdk-typescript';

async function example() {
  console.log("🚀 Testing @equisoft/equisoft-plan-sdk-typescript SDK...");
  const config = new Configuration({ 
    // To configure OAuth2 access token for authorization: OAuth2 implicit
    accessToken: "YOUR ACCESS TOKEN",
  });
  const api = new PlansApi(config);

  const body = {
    // string (optional)
    clientExternalUuid: clientExternalUuid_example,
  } satisfies ListPlansRequest;

  try {
    const data = await api.listPlans(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);
```

### Parameters


| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **clientExternalUuid** | `string` |  | [Optional] [Defaults to `undefined`] |

### Return type

[**PlansListPlansResponse**](PlansListPlansResponse.md)

### Authorization

[OAuth2 implicit](../README.md#OAuth2-implicit)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/json`


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Success |  -  |
| **401** | Access denied |  -  |
| **500** | Server error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)