@clawhub-mickmicksh-e9003238ca
Adyen Balance Control API skill. Use when working with Adyen Balance Control for balanceTransfer. Covers 1 endpoint.
---
name: lap-adyen-balance-control-api
description: "Adyen Balance Control API skill. Use when working with Adyen Balance Control for balanceTransfer. Covers 1 endpoint."
version: 1.0.0
generator: lapsh
metadata:
openclaw:
requires:
env:
- ADYEN_BALANCE_CONTROL_API_KEY
---
# Adyen Balance Control API
API version: 1
## Auth
ApiKey X-API-Key in header | Bearer basic
## Base URL
https://pal-test.adyen.com/pal/servlet/BalanceControl/v1
## Setup
1. Set Authorization header with your Bearer token
3. POST /balanceTransfer -- create first balanceTransfer
## Endpoints
1 endpoints across 1 groups. See references/api-spec.lap for full details.
### balanceTransfer
| Method | Path | Description |
|--------|------|-------------|
| POST | /balanceTransfer | Start a balance transfer |
## Common Questions
Match user requests to endpoints in references/api-spec.lap. Key patterns:
- "Create a balanceTransfer?" -> POST /balanceTransfer
- "How to authenticate?" -> See Auth section
## Response Tips
- Check response schemas in references/api-spec.lap for field details
- Create/update endpoints typically return the created/updated object
## CLI
```bash
# Update this spec to the latest version
npx @lap-platform/lapsh get adyen-balance-control-api -o references/api-spec.lap
# Search for related APIs
npx @lap-platform/lapsh search adyen-balance-control-api
```
## References
- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas
> Generated from the official API spec by [LAP](https://lap.sh)
AdvisorManagementClient API skill. Use when working with AdvisorManagementClient for providers, subscriptions, {resourceUri}. Covers 15 endpoints.
---
name: lap-advisormanagementclient
description: "AdvisorManagementClient API skill. Use when working with AdvisorManagementClient for providers, subscriptions, {resourceUri}. Covers 15 endpoints."
version: 1.0.0
generator: lapsh
metadata:
openclaw:
requires:
env:
- ADVISORMANAGEMENTCLIENT_API_KEY
---
# AdvisorManagementClient
API version: 2017-04-19
## Auth
OAuth2
## Base URL
https://management.azure.com
## Setup
1. Configure auth: OAuth2
2. GET /providers/Microsoft.Advisor/metadata -- verify access
3. POST /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/generateRecommendations -- create first generateRecommendations
## Endpoints
15 endpoints across 3 groups. See references/api-spec.lap for full details.
### providers
| Method | Path | Description |
|--------|------|-------------|
| GET | /providers/Microsoft.Advisor/metadata/{name} | Gets the metadata entity. |
| GET | /providers/Microsoft.Advisor/metadata | Gets the list of metadata entities. |
| GET | /providers/Microsoft.Advisor/operations | Lists all the available Advisor REST API operations. |
### subscriptions
| Method | Path | Description |
|--------|------|-------------|
| GET | /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/configurations | Retrieve Azure Advisor configurations. |
| PUT | /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/configurations | Create/Overwrite Azure Advisor configuration. |
| GET | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Advisor/configurations | Retrieve Azure Advisor configurations. |
| PUT | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Advisor/configurations | Create/Overwrite Azure Advisor configuration. |
| POST | /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/generateRecommendations | Initiates the recommendation generation or computation process for a subscription. This operation is asynchronous. The generated recommendations are stored in a cache in the Advisor service. |
| GET | /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/generateRecommendations/{operationId} | Retrieves the status of the recommendation computation or generation process. Invoke this API after calling the generation recommendation. The URI of this API is returned in the Location field of the response header. |
| GET | /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/recommendations | Obtains cached recommendations for a subscription. The recommendations are generated or computed by invoking generateRecommendations. |
| GET | /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/suppressions | Retrieves the list of snoozed or dismissed suppressions for a subscription. The snoozed or dismissed attribute of a recommendation is referred to as a suppression. |
### {resourceUri}
| Method | Path | Description |
|--------|------|-------------|
| GET | /{resourceUri}/providers/Microsoft.Advisor/recommendations/{recommendationId} | Obtains details of a cached recommendation. |
| GET | /{resourceUri}/providers/Microsoft.Advisor/recommendations/{recommendationId}/suppressions/{name} | Obtains the details of a suppression. |
| PUT | /{resourceUri}/providers/Microsoft.Advisor/recommendations/{recommendationId}/suppressions/{name} | Enables the snoozed or dismissed attribute of a recommendation. The snoozed or dismissed attribute is referred to as a suppression. Use this API to create or update the snoozed or dismissed status of a recommendation. |
| DELETE | /{resourceUri}/providers/Microsoft.Advisor/recommendations/{recommendationId}/suppressions/{name} | Enables the activation of a snoozed or dismissed recommendation. The snoozed or dismissed attribute of a recommendation is referred to as a suppression. |
## Common Questions
Match user requests to endpoints in references/api-spec.lap. Key patterns:
- "Get metadata details?" -> GET /providers/Microsoft.Advisor/metadata/{name}
- "List all metadata?" -> GET /providers/Microsoft.Advisor/metadata
- "List all configurations?" -> GET /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/configurations
- "List all configurations?" -> GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Advisor/configurations
- "Create a generateRecommendation?" -> POST /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/generateRecommendations
- "Get generateRecommendation details?" -> GET /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/generateRecommendations/{operationId}
- "List all recommendations?" -> GET /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/recommendations
- "List all operations?" -> GET /providers/Microsoft.Advisor/operations
- "Get recommendation details?" -> GET /{resourceUri}/providers/Microsoft.Advisor/recommendations/{recommendationId}
- "Get suppression details?" -> GET /{resourceUri}/providers/Microsoft.Advisor/recommendations/{recommendationId}/suppressions/{name}
- "Update a suppression?" -> PUT /{resourceUri}/providers/Microsoft.Advisor/recommendations/{recommendationId}/suppressions/{name}
- "Delete a suppression?" -> DELETE /{resourceUri}/providers/Microsoft.Advisor/recommendations/{recommendationId}/suppressions/{name}
- "List all suppressions?" -> GET /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/suppressions
- "How to authenticate?" -> See Auth section
## Response Tips
- Check response schemas in references/api-spec.lap for field details
- Create/update endpoints typically return the created/updated object
## CLI
```bash
# Update this spec to the latest version
npx @lap-platform/lapsh get advisormanagementclient -o references/api-spec.lap
# Search for related APIs
npx @lap-platform/lapsh search advisormanagementclient
```
## References
- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas
> Generated from the official API spec by [LAP](https://lap.sh)
Adobe Experience Manager (AEM) API skill. Use when working with Adobe Experience Manager (AEM) for system, libs, .cqactions.html. Covers 48 endpoints.
---
name: lap-adobe-experience-manager-aem-api
description: "Adobe Experience Manager (AEM) API skill. Use when working with Adobe Experience Manager (AEM) for system, libs, .cqactions.html. Covers 48 endpoints."
version: 1.0.0
generator: lapsh
metadata:
openclaw:
requires:
env:
- ADOBE_EXPERIENCE_MANAGER_AEM_API_KEY
---
# Adobe Experience Manager (AEM) API
API version: 3.7.1-pre.0
## Auth
Bearer basic
## Base URL
/
## Setup
1. Set Authorization header with your Bearer token
2. GET /system/console/configMgr -- verify access
3. POST /.cqactions.html -- create first .cqactions.html
## Endpoints
48 endpoints across 9 groups. See references/api-spec.lap for full details.
### system
| Method | Path | Description |
|--------|------|-------------|
| GET | /system/console/configMgr | |
| GET | /system/console/bundles/{name}.json | |
| POST | /system/console/bundles/{name} | |
| POST | /system/console/jmx/com.adobe.granite:type=Repository/op/{action} | |
| GET | /system/health | |
| POST | /system/console/configMgr/com.adobe.granite.auth.saml.SamlAuthenticationHandler | |
| GET | /system/console/status-productinfo.json | |
### libs
| Method | Path | Description |
|--------|------|-------------|
| GET | /libs/granite/core/content/login.html | |
| POST | /libs/replication/treeactivation.html | |
| POST | /libs/granite/security/post/authorizables | |
| POST | /libs/granite/security/post/truststore | |
| GET | /libs/granite/security/truststore.json | |
| POST | /libs/granite/security/post/sslSetup.html | |
### .cqactions.html
| Method | Path | Description |
|--------|------|-------------|
| POST | /.cqactions.html | |
### {path}
| Method | Path | Description |
|--------|------|-------------|
| POST | /{path}/ | |
| GET | /{path}/{name} | |
| POST | /{path}/{name} | |
| DELETE | /{path}/{name} | |
| POST | /{path}/{name}.rw.html | |
### apps
| Method | Path | Description |
|--------|------|-------------|
| POST | /apps/system/config/{configNodeName} | |
| POST | /apps/system/config/org.apache.felix.http | |
| POST | /apps/system/config/org.apache.sling.servlets.get.DefaultGetServlet | |
| POST | /apps/system/config/org.apache.sling.security.impl.ReferrerFilter | |
| POST | /apps/system/config/org.apache.sling.jcr.davex.impl.servlets.SlingDavExServlet | |
| POST | /apps/system/config/com.shinesolutions.aem.passwordreset.Activator | |
| POST | /apps/system/config/com.shinesolutions.healthcheck.hc.impl.ActiveBundleHealthCheck | |
| POST | /apps/system/config/com.adobe.granite.auth.saml.SamlAuthenticationHandler.config | |
| POST | /apps/system/config/org.apache.http.proxyconfigurator.config | |
### bin
| Method | Path | Description |
|--------|------|-------------|
| GET | /bin/querybuilder.json | |
| POST | /bin/querybuilder.json | |
### etc
| Method | Path | Description |
|--------|------|-------------|
| GET | /etc/packages/{group}/{name}-{version}.zip | |
| GET | /etc/packages/{group}/{name}-{version}.zip/jcr:content/vlt:definition/filter.tidy.2.json | |
| GET | /etc/replication/agents.{runmode}.-1.json | |
| GET | /etc/replication/agents.{runmode}/{name} | |
| DELETE | /etc/replication/agents.{runmode}/{name} | |
| POST | /etc/replication/agents.{runmode}/{name} | |
| GET | /etc/truststore/truststore.p12 | |
| POST | /etc/truststore | |
### crx
| Method | Path | Description |
|--------|------|-------------|
| POST | /crx/explorer/ui/setpassword.jsp | |
| GET | /crx/packmgr/installstatus.jsp | |
| POST | /crx/packmgr/service.jsp | |
| POST | /crx/packmgr/update.jsp | |
| POST | /crx/packmgr/service/.json/{path} | |
| GET | /crx/packmgr/service/script.html | |
| GET | /crx/server/crx.default/jcr:root/.1.json | |
### {intermediatePath}
| Method | Path | Description |
|--------|------|-------------|
| POST | /{intermediatePath}/{authorizableId}.ks.html | |
| GET | /{intermediatePath}/{authorizableId}.ks.json | |
| GET | /{intermediatePath}/{authorizableId}/keystore/store.p12 | |
## Common Questions
Match user requests to endpoints in references/api-spec.lap. Key patterns:
- "List all configMgr?" -> GET /system/console/configMgr
- "List all login.html?" -> GET /libs/granite/core/content/login.html
- "Create a .cqactions.html?" -> POST /.cqactions.html
- "Create a org.apache.felix.http?" -> POST /apps/system/config/org.apache.felix.http
- "Create a org.apache.sling.servlets.get.DefaultGetServlet?" -> POST /apps/system/config/org.apache.sling.servlets.get.DefaultGetServlet
- "Create a org.apache.sling.security.impl.ReferrerFilter?" -> POST /apps/system/config/org.apache.sling.security.impl.ReferrerFilter
- "Create a org.apache.sling.jcr.davex.impl.servlets.SlingDavExServlet?" -> POST /apps/system/config/org.apache.sling.jcr.davex.impl.servlets.SlingDavExServlet
- "Create a com.shinesolutions.aem.passwordreset.Activator?" -> POST /apps/system/config/com.shinesolutions.aem.passwordreset.Activator
- "Create a com.shinesolutions.healthcheck.hc.impl.ActiveBundleHealthCheck?" -> POST /apps/system/config/com.shinesolutions.healthcheck.hc.impl.ActiveBundleHealthCheck
- "List all querybuilder.json?" -> GET /bin/querybuilder.json
- "Create a querybuilder.json?" -> POST /bin/querybuilder.json
- "Get package details?" -> GET /etc/packages/{group}/{name}-{version}.zip
- "List all filter.tidy.2.json?" -> GET /etc/packages/{group}/{name}-{version}.zip/jcr:content/vlt:definition/filter.tidy.2.json
- "Get agents.{runmode}.-1.json details?" -> GET /etc/replication/agents.{runmode}.-1.json
- "Get agents.{runmode} details?" -> GET /etc/replication/agents.{runmode}/{name}
- "Delete a agents.{runmode}?" -> DELETE /etc/replication/agents.{runmode}/{name}
- "Create a treeactivation.html?" -> POST /libs/replication/treeactivation.html
- "Create a authorizable?" -> POST /libs/granite/security/post/authorizables
- "Create a setpassword.jsp?" -> POST /crx/explorer/ui/setpassword.jsp
- "List all installstatus.jsp?" -> GET /crx/packmgr/installstatus.jsp
- "Create a service.jsp?" -> POST /crx/packmgr/service.jsp
- "Create a update.jsp?" -> POST /crx/packmgr/update.jsp
- "List all script.html?" -> GET /crx/packmgr/service/script.html
- "List all .1.json?" -> GET /crx/server/crx.default/jcr:root/.1.json
- "Get bundle details?" -> GET /system/console/bundles/{name}.json
- "List all health?" -> GET /system/health
- "Create a com.adobe.granite.auth.saml.SamlAuthenticationHandler.config?" -> POST /apps/system/config/com.adobe.granite.auth.saml.SamlAuthenticationHandler.config
- "Create a org.apache.http.proxyconfigurator.config?" -> POST /apps/system/config/org.apache.http.proxyconfigurator.config
- "Create a truststore?" -> POST /libs/granite/security/post/truststore
- "List all truststore.json?" -> GET /libs/granite/security/truststore.json
- "List all truststore.p12?" -> GET /etc/truststore/truststore.p12
- "Create a truststore?" -> POST /etc/truststore
- "Create a com.adobe.granite.auth.saml.SamlAuthenticationHandler?" -> POST /system/console/configMgr/com.adobe.granite.auth.saml.SamlAuthenticationHandler
- "List all status-productinfo.json?" -> GET /system/console/status-productinfo.json
- "List all store.p12?" -> GET /{intermediatePath}/{authorizableId}/keystore/store.p12
- "Create a sslSetup.html?" -> POST /libs/granite/security/post/sslSetup.html
- "How to authenticate?" -> See Auth section
## Response Tips
- Check response schemas in references/api-spec.lap for field details
- Create/update endpoints typically return the created/updated object
## CLI
```bash
# Update this spec to the latest version
npx @lap-platform/lapsh get adobe-experience-manager-aem-api -o references/api-spec.lap
# Search for related APIs
npx @lap-platform/lapsh search adobe-experience-manager-aem-api
```
## References
- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas
> Generated from the official API spec by [LAP](https://lap.sh)
ADHybridHealthService API skill. Use when working with ADHybridHealthService for providers. Covers 77 endpoints.
---
name: lap-adhybridhealthservice
description: "ADHybridHealthService API skill. Use when working with ADHybridHealthService for providers. Covers 77 endpoints."
version: 1.0.0
generator: lapsh
metadata:
openclaw:
requires:
env:
- ADHYBRIDHEALTHSERVICE_API_KEY
---
# ADHybridHealthService
API version: 2014-01-01
## Auth
OAuth2
## Base URL
https://management.azure.com
## Setup
1. Configure auth: OAuth2
2. GET /providers/Microsoft.ADHybridHealthService/addsservices -- verify access
3. POST /providers/Microsoft.ADHybridHealthService/addsservices -- create first addsservices
## Endpoints
77 endpoints across 1 groups. See references/api-spec.lap for full details.
### providers
| Method | Path | Description |
|--------|------|-------------|
| GET | /providers/Microsoft.ADHybridHealthService/addsservices | Gets the details of Active Directory Domain Service, for a tenant, that are onboarded to Azure Active Directory Connect Health. |
| POST | /providers/Microsoft.ADHybridHealthService/addsservices | Onboards a service for a given tenant in Azure Active Directory Connect Health. |
| GET | /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName} | Gets the details of an Active Directory Domain Service for a tenant having Azure AD Premium license and is onboarded to Azure Active Directory Connect Health. |
| DELETE | /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName} | Deletes an Active Directory Domain Service which is onboarded to Azure Active Directory Connect Health. |
| PATCH | /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName} | Updates an Active Directory Domain Service properties of an onboarded service. |
| GET | /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/alerts | Gets the alerts for a given Active Directory Domain Service. |
| GET | /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/configuration | Gets the service configurations. |
| GET | /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/dimensions/{dimension} | Gets the dimensions for a given dimension type in a server. |
| GET | /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/addsservicemembers | Gets the details of the Active Directory Domain servers, for a given Active Directory Domain Service, that are onboarded to Azure Active Directory Connect Health. |
| GET | /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/addomainservicemembers | Gets the details of the servers, for a given Active Directory Domain Service, that are onboarded to Azure Active Directory Connect Health. |
| GET | /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/features/{featureName}/userpreference | Gets the user preferences for a given feature. |
| DELETE | /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/features/{featureName}/userpreference | Deletes the user preferences for a given feature. |
| POST | /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/features/{featureName}/userpreference | Adds the user preferences for a given feature. |
| GET | /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/forestsummary | Gets the forest summary for a given Active Directory Domain Service, that is onboarded to Azure Active Directory Connect Health. |
| GET | /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metrics/{metricName}/groups/{groupName} | Gets the server related metrics for a given metric and group combination. |
| GET | /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metrics/{metricName}/groups/{groupName}/average | Gets the average of the metric values for a given metric and group combination. |
| GET | /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metrics/{metricName}/groups/{groupName}/sum | Gets the sum of the metric values for a given metric and group combination. |
| GET | /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metricmetadata | Gets the service related metrics information. |
| GET | /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metricmetadata/{metricName} | Gets the service related metric information. |
| GET | /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metricmetadata/{metricName}/groups/{groupName} | Gets the service related metrics for a given metric and group combination. |
| GET | /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/replicationdetails | Gets complete domain controller list along with replication details for a given Active Directory Domain Service, that is onboarded to Azure Active Directory Connect Health. |
| GET | /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/replicationstatus | Gets Replication status for a given Active Directory Domain Service, that is onboarded to Azure Active Directory Connect Health. |
| GET | /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/replicationsummary | Gets complete domain controller list along with replication details for a given Active Directory Domain Service, that is onboarded to Azure Active Directory Connect Health. |
| GET | /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers | Gets the details of the servers, for a given Active Directory Domain Controller service, that are onboarded to Azure Active Directory Connect Health Service. |
| POST | /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers | Onboards a server, for a given Active Directory Domain Controller service, to Azure Active Directory Connect Health Service. |
| GET | /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers/{serviceMemberId} | Gets the details of a server, for a given Active Directory Domain Controller service, that are onboarded to Azure Active Directory Connect Health Service. |
| DELETE | /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers/{serviceMemberId} | Deletes a Active Directory Domain Controller server that has been onboarded to Azure Active Directory Connect Health Service. |
| GET | /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers/{serviceMemberId}/alerts | Gets the details of an alert for a given Active Directory Domain Controller service and server combination. |
| GET | /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers/{serviceMemberId}/credentials | Gets the credentials of the server which is needed by the agent to connect to Azure Active Directory Connect Health Service. |
| GET | /providers/Microsoft.ADHybridHealthService/addsservices/premiumCheck | Gets the details of Active Directory Domain Services for a tenant having Azure AD Premium license and is onboarded to Azure Active Directory Connect Health. |
| GET | /providers/Microsoft.ADHybridHealthService/operations | Lists the available Azure Data Factory API operations. |
| POST | /providers/Microsoft.ADHybridHealthService/configuration | Onboards a tenant in Azure Active Directory Connect Health. |
| GET | /providers/Microsoft.ADHybridHealthService/configuration | Gets the details of a tenant onboarded to Azure Active Directory Connect Health. |
| PATCH | /providers/Microsoft.ADHybridHealthService/configuration | Updates tenant properties for tenants onboarded to Azure Active Directory Connect Health. |
| GET | /providers/Microsoft.ADHybridHealthService/reports/DevOps/IsDevOps | Checks if the user is enabled for Dev Ops access. |
| GET | /providers/Microsoft.ADHybridHealthService/services | Gets the details of services, for a tenant, that are onboarded to Azure Active Directory Connect Health. |
| POST | /providers/Microsoft.ADHybridHealthService/services | Onboards a service for a given tenant in Azure Active Directory Connect Health. |
| GET | /providers/Microsoft.ADHybridHealthService/services/premiumCheck | Gets the details of services for a tenant having Azure AD Premium license and is onboarded to Azure Active Directory Connect Health. |
| GET | /providers/Microsoft.ADHybridHealthService/services/{serviceName} | Gets the details of a service for a tenant having Azure AD Premium license and is onboarded to Azure Active Directory Connect Health. |
| DELETE | /providers/Microsoft.ADHybridHealthService/services/{serviceName} | Deletes a service which is onboarded to Azure Active Directory Connect Health. |
| PATCH | /providers/Microsoft.ADHybridHealthService/services/{serviceName} | Updates the service properties of an onboarded service. |
| GET | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/alerts | Gets the alerts for a given service. |
| GET | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/checkServiceFeatureAvailibility/{featureName} | Checks if the service has all the pre-requisites met to use a feature. |
| GET | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/exporterrors/counts | Gets the count of latest AAD export errors. |
| GET | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/exporterrors/listV2 | Gets the categorized export errors. |
| GET | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/exportstatus | Gets the export status. |
| POST | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/feedbacktype/alerts/feedback | Adds an alert feedback submitted by customer. |
| GET | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/feedbacktype/alerts/{shortName}/alertfeedback | Gets a list of all alert feedback for a given tenant and alert type. |
| GET | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/metrics/{metricName}/groups/{groupName} | Gets the server related metrics for a given metric and group combination. |
| GET | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/metrics/{metricName}/groups/{groupName}/average | Gets the average of the metric values for a given metric and group combination. |
| GET | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/metrics/{metricName}/groups/{groupName}/sum | Gets the sum of the metric values for a given metric and group combination. |
| GET | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/metricmetadata | Gets the service related metrics information. |
| GET | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/metricmetadata/{metricName} | Gets the service related metrics information. |
| GET | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/metricmetadata/{metricName}/groups/{groupName} | Gets the service related metrics for a given metric and group combination. |
| PATCH | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/monitoringconfiguration | Updates the service level monitoring configuration. |
| GET | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/monitoringconfigurations | Gets the service level monitoring configurations. |
| GET | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/reports/badpassword/details/user | Gets the bad password login attempt report for an user |
| GET | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers | Gets the details of the servers, for a given service, that are onboarded to Azure Active Directory Connect Health Service. |
| POST | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers | Onboards a server, for a given service, to Azure Active Directory Connect Health Service. |
| GET | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId} | Gets the details of a server, for a given service, that are onboarded to Azure Active Directory Connect Health Service. |
| DELETE | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId} | Deletes a server that has been onboarded to Azure Active Directory Connect Health Service. |
| GET | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/alerts | Gets the details of an alert for a given service and server combination. |
| GET | /providers/Microsoft.ADHybridHealthService/service/{serviceName}/servicemembers/{serviceMemberId}/connectors | Gets the connector details for a service. |
| GET | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/credentials | Gets the credentials of the server which is needed by the agent to connect to Azure Active Directory Connect Health Service. |
| DELETE | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/data | Deletes the data uploaded by the server to Azure Active Directory Connect Health Service. |
| GET | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/datafreshness | Gets the last time when the server uploaded data to Azure Active Directory Connect Health Service. |
| GET | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/exportstatus | Gets the export status. |
| GET | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/globalconfiguration | Gets the global configuration. |
| GET | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/metrics/{metricName}/groups/{groupName} | Gets the server related metrics for a given metric and group combination. |
| GET | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/serviceconfiguration | Gets the service configuration. |
| GET | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/TenantWhitelisting/{featureName} | Checks if the tenant, to which a service is registered, is listed as allowed to use a feature. |
| GET | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/reports/riskyIp/blobUris | Gets all Risky IP report URIs for the last 7 days. |
| POST | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/reports/riskyIp/generateBlobUri | Initiate the generation of a new Risky IP report. Returns the URI for the new one. |
| GET | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/metrics/{metricName} | Gets the list of connectors and run profile names. |
| GET | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/ipAddressAggregates | Gets the IP address aggregates for a given service. |
| GET | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/ipAddressAggregateSettings | Gets the IP address aggregate settings. |
| PATCH | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/ipAddressAggregateSettings | Updates the IP address aggregate settings alert thresholds. |
## Common Questions
Match user requests to endpoints in references/api-spec.lap. Key patterns:
- "List all addsservices?" -> GET /providers/Microsoft.ADHybridHealthService/addsservices
- "Create a addsservice?" -> POST /providers/Microsoft.ADHybridHealthService/addsservices
- "Get addsservice details?" -> GET /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}
- "Delete a addsservice?" -> DELETE /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}
- "Partially update a addsservice?" -> PATCH /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}
- "List all alerts?" -> GET /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/alerts
- "List all configuration?" -> GET /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/configuration
- "Get dimension details?" -> GET /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/dimensions/{dimension}
- "List all addsservicemembers?" -> GET /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/addsservicemembers
- "Search addomainservicemembers?" -> GET /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/addomainservicemembers
- "List all userpreference?" -> GET /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/features/{featureName}/userpreference
- "Create a userpreference?" -> POST /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/features/{featureName}/userpreference
- "List all forestsummary?" -> GET /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/forestsummary
- "Get group details?" -> GET /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metrics/{metricName}/groups/{groupName}
- "List all average?" -> GET /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metrics/{metricName}/groups/{groupName}/average
- "List all sum?" -> GET /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metrics/{metricName}/groups/{groupName}/sum
- "List all metricmetadata?" -> GET /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metricmetadata
- "Get metricmetadata details?" -> GET /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metricmetadata/{metricName}
- "Get group details?" -> GET /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metricmetadata/{metricName}/groups/{groupName}
- "List all replicationdetails?" -> GET /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/replicationdetails
- "List all replicationstatus?" -> GET /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/replicationstatus
- "Search replicationsummary?" -> GET /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/replicationsummary
- "List all servicemembers?" -> GET /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers
- "Create a servicemember?" -> POST /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers
- "Get servicemember details?" -> GET /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers/{serviceMemberId}
- "Delete a servicemember?" -> DELETE /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers/{serviceMemberId}
- "List all alerts?" -> GET /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers/{serviceMemberId}/alerts
- "List all credentials?" -> GET /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers/{serviceMemberId}/credentials
- "List all premiumCheck?" -> GET /providers/Microsoft.ADHybridHealthService/addsservices/premiumCheck
- "List all operations?" -> GET /providers/Microsoft.ADHybridHealthService/operations
- "Create a configuration?" -> POST /providers/Microsoft.ADHybridHealthService/configuration
- "List all configuration?" -> GET /providers/Microsoft.ADHybridHealthService/configuration
- "List all IsDevOps?" -> GET /providers/Microsoft.ADHybridHealthService/reports/DevOps/IsDevOps
- "List all services?" -> GET /providers/Microsoft.ADHybridHealthService/services
- "Create a service?" -> POST /providers/Microsoft.ADHybridHealthService/services
- "List all premiumCheck?" -> GET /providers/Microsoft.ADHybridHealthService/services/premiumCheck
- "Get service details?" -> GET /providers/Microsoft.ADHybridHealthService/services/{serviceName}
- "Delete a service?" -> DELETE /providers/Microsoft.ADHybridHealthService/services/{serviceName}
- "Partially update a service?" -> PATCH /providers/Microsoft.ADHybridHealthService/services/{serviceName}
- "List all alerts?" -> GET /providers/Microsoft.ADHybridHealthService/services/{serviceName}/alerts
- "Get checkServiceFeatureAvailibility details?" -> GET /providers/Microsoft.ADHybridHealthService/services/{serviceName}/checkServiceFeatureAvailibility/{featureName}
- "List all counts?" -> GET /providers/Microsoft.ADHybridHealthService/services/{serviceName}/exporterrors/counts
- "List all listV2?" -> GET /providers/Microsoft.ADHybridHealthService/services/{serviceName}/exporterrors/listV2
- "List all exportstatus?" -> GET /providers/Microsoft.ADHybridHealthService/services/{serviceName}/exportstatus
- "Create a feedback?" -> POST /providers/Microsoft.ADHybridHealthService/services/{serviceName}/feedbacktype/alerts/feedback
- "List all alertfeedback?" -> GET /providers/Microsoft.ADHybridHealthService/services/{serviceName}/feedbacktype/alerts/{shortName}/alertfeedback
- "Get group details?" -> GET /providers/Microsoft.ADHybridHealthService/services/{serviceName}/metrics/{metricName}/groups/{groupName}
- "List all average?" -> GET /providers/Microsoft.ADHybridHealthService/services/{serviceName}/metrics/{metricName}/groups/{groupName}/average
- "List all sum?" -> GET /providers/Microsoft.ADHybridHealthService/services/{serviceName}/metrics/{metricName}/groups/{groupName}/sum
- "List all metricmetadata?" -> GET /providers/Microsoft.ADHybridHealthService/services/{serviceName}/metricmetadata
- "Get metricmetadata details?" -> GET /providers/Microsoft.ADHybridHealthService/services/{serviceName}/metricmetadata/{metricName}
- "Get group details?" -> GET /providers/Microsoft.ADHybridHealthService/services/{serviceName}/metricmetadata/{metricName}/groups/{groupName}
- "List all monitoringconfigurations?" -> GET /providers/Microsoft.ADHybridHealthService/services/{serviceName}/monitoringconfigurations
- "List all user?" -> GET /providers/Microsoft.ADHybridHealthService/services/{serviceName}/reports/badpassword/details/user
- "List all servicemembers?" -> GET /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers
- "Create a servicemember?" -> POST /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers
- "Get servicemember details?" -> GET /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}
- "Delete a servicemember?" -> DELETE /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}
- "List all alerts?" -> GET /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/alerts
- "List all connectors?" -> GET /providers/Microsoft.ADHybridHealthService/service/{serviceName}/servicemembers/{serviceMemberId}/connectors
- "List all credentials?" -> GET /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/credentials
- "List all datafreshness?" -> GET /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/datafreshness
- "List all exportstatus?" -> GET /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/exportstatus
- "List all globalconfiguration?" -> GET /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/globalconfiguration
- "Get group details?" -> GET /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/metrics/{metricName}/groups/{groupName}
- "List all serviceconfiguration?" -> GET /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/serviceconfiguration
- "Get TenantWhitelisting details?" -> GET /providers/Microsoft.ADHybridHealthService/services/{serviceName}/TenantWhitelisting/{featureName}
- "List all blobUris?" -> GET /providers/Microsoft.ADHybridHealthService/services/{serviceName}/reports/riskyIp/blobUris
- "Create a generateBlobUri?" -> POST /providers/Microsoft.ADHybridHealthService/services/{serviceName}/reports/riskyIp/generateBlobUri
- "Get metric details?" -> GET /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/metrics/{metricName}
- "List all ipAddressAggregates?" -> GET /providers/Microsoft.ADHybridHealthService/services/{serviceName}/ipAddressAggregates
- "List all ipAddressAggregateSettings?" -> GET /providers/Microsoft.ADHybridHealthService/services/{serviceName}/ipAddressAggregateSettings
- "How to authenticate?" -> See Auth section
## Response Tips
- Check response schemas in references/api-spec.lap for field details
- Create/update endpoints typically return the created/updated object
## CLI
```bash
# Update this spec to the latest version
npx @lap-platform/lapsh get adhybridhealthservice -o references/api-spec.lap
# Search for related APIs
npx @lap-platform/lapsh search adhybridhealthservice
```
## References
- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas
> Generated from the official API spec by [LAP](https://lap.sh)
Adafruit IO REST API skill. Use when working with Adafruit IO REST for user, {username}, webhooks. Covers 71 endpoints.
---
name: lap-adafruit-io-rest-api
description: "Adafruit IO REST API skill. Use when working with Adafruit IO REST for user, {username}, webhooks. Covers 71 endpoints."
version: 1.0.0
generator: lapsh
metadata:
openclaw:
requires:
env:
- ADAFRUIT_IO_REST_API_KEY
---
# Adafruit IO REST API
API version: 2.0.0
## Auth
ApiKey X-AIO-Key in header | ApiKey X-AIO-Key in query | ApiKey X-AIO-Signature in header
## Base URL
https://io.adafruit.com/api/v2
## Setup
1. Set your API key in the appropriate header
2. GET /user -- verify access
3. POST /{username}/feeds -- create first feeds
## Endpoints
71 endpoints across 3 groups. See references/api-spec.lap for full details.
### user
| Method | Path | Description |
|--------|------|-------------|
| GET | /user | Get information about the current user |
### {username}
| Method | Path | Description |
|--------|------|-------------|
| GET | /{username}/throttle | Get the user's data rate limit and current activity level. |
| GET | /{username}/activities | All activities for current user |
| DELETE | /{username}/activities | All activities for current user |
| GET | /{username}/activities/{type} | Get activities by type for current user |
| GET | /{username}/feeds | All feeds for current user |
| POST | /{username}/feeds | Create a new Feed |
| GET | /{username}/feeds/{feed_key} | Get feed by feed key |
| PUT | /{username}/feeds/{feed_key} | Replace an existing Feed |
| PATCH | /{username}/feeds/{feed_key} | Update properties of an existing Feed |
| DELETE | /{username}/feeds/{feed_key} | Delete an existing Feed |
| GET | /{username}/feeds/{feed_key}/details | Get detailed feed by feed key |
| GET | /{username}/feeds/{feed_key}/data | Get all data for the given feed |
| POST | /{username}/feeds/{feed_key}/data | Create new Data |
| GET | /{username}/feeds/{feed_key}/data/chart | Chart data for current feed |
| POST | /{username}/feeds/{feed_key}/data/batch | Create multiple new Data records |
| GET | /{username}/feeds/{feed_key}/data/previous | Previous Data in Queue |
| GET | /{username}/feeds/{feed_key}/data/next | Next Data in Queue |
| GET | /{username}/feeds/{feed_key}/data/last | Last Data in Queue |
| GET | /{username}/feeds/{feed_key}/data/first | First Data in Queue |
| GET | /{username}/feeds/{feed_key}/data/retain | Last Data in MQTT CSV format |
| GET | /{username}/feeds/{feed_key}/data/{id} | Returns data based on feed key |
| PUT | /{username}/feeds/{feed_key}/data/{id} | Replace existing Data |
| PATCH | /{username}/feeds/{feed_key}/data/{id} | Update properties of existing Data |
| DELETE | /{username}/feeds/{feed_key}/data/{id} | Delete existing Data |
| GET | /{username}/groups | All groups for current user |
| POST | /{username}/groups | Create a new Group |
| GET | /{username}/groups/{group_key} | Returns Group based on ID |
| PUT | /{username}/groups/{group_key} | Replace an existing Group |
| PATCH | /{username}/groups/{group_key} | Update properties of an existing Group |
| DELETE | /{username}/groups/{group_key} | Delete an existing Group |
| POST | /{username}/groups/{group_key}/add | Add an existing Feed to a Group |
| POST | /{username}/groups/{group_key}/remove | Remove a Feed from a Group |
| GET | /{username}/groups/{group_key}/feeds | All feeds for current user in a given group |
| POST | /{username}/groups/{group_key}/feeds | Create a new Feed in a Group |
| POST | /{username}/groups/{group_key}/data | Create new data for multiple feeds in a group |
| GET | /{username}/groups/{group_key}/feeds/{feed_key}/data | All data for current feed in a specific group |
| POST | /{username}/groups/{group_key}/feeds/{feed_key}/data | Create new Data in a feed belonging to a particular group |
| POST | /{username}/groups/{group_key}/feeds/{feed_key}/data/batch | Create multiple new Data records in a feed belonging to a particular group |
| GET | /{username}/dashboards | All dashboards for current user |
| POST | /{username}/dashboards | Create a new Dashboard |
| GET | /{username}/dashboards/{id} | Returns Dashboard based on ID |
| PUT | /{username}/dashboards/{id} | Replace an existing Dashboard |
| PATCH | /{username}/dashboards/{id} | Update properties of an existing Dashboard |
| DELETE | /{username}/dashboards/{id} | Delete an existing Dashboard |
| GET | /{username}/dashboards/{dashboard_id}/blocks | All blocks for current user |
| POST | /{username}/dashboards/{dashboard_id}/blocks | Create a new Block |
| GET | /{username}/dashboards/{dashboard_id}/blocks/{id} | Returns Block based on ID |
| PUT | /{username}/dashboards/{dashboard_id}/blocks/{id} | Replace an existing Block |
| PATCH | /{username}/dashboards/{dashboard_id}/blocks/{id} | Update properties of an existing Block |
| DELETE | /{username}/dashboards/{dashboard_id}/blocks/{id} | Delete an existing Block |
| GET | /{username}/tokens | All tokens for current user |
| POST | /{username}/tokens | Create a new Token |
| GET | /{username}/tokens/{id} | Returns Token based on ID |
| PUT | /{username}/tokens/{id} | Replace an existing Token |
| PATCH | /{username}/tokens/{id} | Update properties of an existing Token |
| DELETE | /{username}/tokens/{id} | Delete an existing Token |
| GET | /{username}/triggers | All triggers for current user |
| POST | /{username}/triggers | Create a new Trigger |
| GET | /{username}/triggers/{id} | Returns Trigger based on ID |
| PUT | /{username}/triggers/{id} | Replace an existing Trigger |
| PATCH | /{username}/triggers/{id} | Update properties of an existing Trigger |
| DELETE | /{username}/triggers/{id} | Delete an existing Trigger |
| GET | /{username}/{type}/{type_id}/acl | All permissions for current user and type |
| POST | /{username}/{type}/{type_id}/acl | Create a new Permission |
| GET | /{username}/{type}/{type_id}/acl/{id} | Returns Permission based on ID |
| PUT | /{username}/{type}/{type_id}/acl/{id} | Replace an existing Permission |
| PATCH | /{username}/{type}/{type_id}/acl/{id} | Update properties of an existing Permission |
| DELETE | /{username}/{type}/{type_id}/acl/{id} | Delete an existing Permission |
### webhooks
| Method | Path | Description |
|--------|------|-------------|
| POST | /webhooks/feed/:token | Send data to a feed via webhook URL. |
| POST | /webhooks/feed/:token/raw | Send arbitrary data to a feed via webhook URL. |
## Common Questions
Match user requests to endpoints in references/api-spec.lap. Key patterns:
- "List all user?" -> GET /user
- "List all throttle?" -> GET /{username}/throttle
- "List all activities?" -> GET /{username}/activities
- "Get activity details?" -> GET /{username}/activities/{type}
- "List all feeds?" -> GET /{username}/feeds
- "Create a feed?" -> POST /{username}/feeds
- "Get feed details?" -> GET /{username}/feeds/{feed_key}
- "Update a feed?" -> PUT /{username}/feeds/{feed_key}
- "Partially update a feed?" -> PATCH /{username}/feeds/{feed_key}
- "Delete a feed?" -> DELETE /{username}/feeds/{feed_key}
- "List all details?" -> GET /{username}/feeds/{feed_key}/details
- "List all data?" -> GET /{username}/feeds/{feed_key}/data
- "Create a data?" -> POST /{username}/feeds/{feed_key}/data
- "List all chart?" -> GET /{username}/feeds/{feed_key}/data/chart
- "Create a batch?" -> POST /{username}/feeds/{feed_key}/data/batch
- "List all previous?" -> GET /{username}/feeds/{feed_key}/data/previous
- "List all next?" -> GET /{username}/feeds/{feed_key}/data/next
- "List all last?" -> GET /{username}/feeds/{feed_key}/data/last
- "List all first?" -> GET /{username}/feeds/{feed_key}/data/first
- "List all retain?" -> GET /{username}/feeds/{feed_key}/data/retain
- "Get data details?" -> GET /{username}/feeds/{feed_key}/data/{id}
- "Update a data?" -> PUT /{username}/feeds/{feed_key}/data/{id}
- "Partially update a data?" -> PATCH /{username}/feeds/{feed_key}/data/{id}
- "Delete a data?" -> DELETE /{username}/feeds/{feed_key}/data/{id}
- "List all groups?" -> GET /{username}/groups
- "Create a group?" -> POST /{username}/groups
- "Get group details?" -> GET /{username}/groups/{group_key}
- "Update a group?" -> PUT /{username}/groups/{group_key}
- "Partially update a group?" -> PATCH /{username}/groups/{group_key}
- "Delete a group?" -> DELETE /{username}/groups/{group_key}
- "Create a add?" -> POST /{username}/groups/{group_key}/add
- "Create a remove?" -> POST /{username}/groups/{group_key}/remove
- "List all feeds?" -> GET /{username}/groups/{group_key}/feeds
- "Create a feed?" -> POST /{username}/groups/{group_key}/feeds
- "Create a data?" -> POST /{username}/groups/{group_key}/data
- "List all data?" -> GET /{username}/groups/{group_key}/feeds/{feed_key}/data
- "Create a data?" -> POST /{username}/groups/{group_key}/feeds/{feed_key}/data
- "Create a batch?" -> POST /{username}/groups/{group_key}/feeds/{feed_key}/data/batch
- "List all dashboards?" -> GET /{username}/dashboards
- "Create a dashboard?" -> POST /{username}/dashboards
- "Get dashboard details?" -> GET /{username}/dashboards/{id}
- "Update a dashboard?" -> PUT /{username}/dashboards/{id}
- "Partially update a dashboard?" -> PATCH /{username}/dashboards/{id}
- "Delete a dashboard?" -> DELETE /{username}/dashboards/{id}
- "List all blocks?" -> GET /{username}/dashboards/{dashboard_id}/blocks
- "Create a block?" -> POST /{username}/dashboards/{dashboard_id}/blocks
- "Get block details?" -> GET /{username}/dashboards/{dashboard_id}/blocks/{id}
- "Update a block?" -> PUT /{username}/dashboards/{dashboard_id}/blocks/{id}
- "Partially update a block?" -> PATCH /{username}/dashboards/{dashboard_id}/blocks/{id}
- "Delete a block?" -> DELETE /{username}/dashboards/{dashboard_id}/blocks/{id}
- "List all tokens?" -> GET /{username}/tokens
- "Create a token?" -> POST /{username}/tokens
- "Get token details?" -> GET /{username}/tokens/{id}
- "Update a token?" -> PUT /{username}/tokens/{id}
- "Partially update a token?" -> PATCH /{username}/tokens/{id}
- "Delete a token?" -> DELETE /{username}/tokens/{id}
- "List all triggers?" -> GET /{username}/triggers
- "Create a trigger?" -> POST /{username}/triggers
- "Get trigger details?" -> GET /{username}/triggers/{id}
- "Update a trigger?" -> PUT /{username}/triggers/{id}
- "Partially update a trigger?" -> PATCH /{username}/triggers/{id}
- "Delete a trigger?" -> DELETE /{username}/triggers/{id}
- "List all acl?" -> GET /{username}/{type}/{type_id}/acl
- "Create a acl?" -> POST /{username}/{type}/{type_id}/acl
- "Get acl details?" -> GET /{username}/{type}/{type_id}/acl/{id}
- "Update a acl?" -> PUT /{username}/{type}/{type_id}/acl/{id}
- "Partially update a acl?" -> PATCH /{username}/{type}/{type_id}/acl/{id}
- "Delete a acl?" -> DELETE /{username}/{type}/{type_id}/acl/{id}
- "Create a :token?" -> POST /webhooks/feed/:token
- "Create a raw?" -> POST /webhooks/feed/:token/raw
- "How to authenticate?" -> See Auth section
## Response Tips
- Check response schemas in references/api-spec.lap for field details
- List endpoints may support pagination; check for limit, offset, or cursor params
- Create/update endpoints typically return the created/updated object
## CLI
```bash
# Update this spec to the latest version
npx @lap-platform/lapsh get adafruit-io-rest-api -o references/api-spec.lap
# Search for related APIs
npx @lap-platform/lapsh search adafruit-io-rest-api
```
## References
- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas
> Generated from the official API spec by [LAP](https://lap.sh)
ACE Provisioning ManagementPartner API skill. Use when working with ACE Provisioning ManagementPartner for providers. Covers 6 endpoints.
---
name: lap-ace-provisioning-managementpartner-api
description: "ACE Provisioning ManagementPartner API skill. Use when working with ACE Provisioning ManagementPartner for providers. Covers 6 endpoints."
version: 1.0.0
generator: lapsh
metadata:
openclaw:
requires:
env:
- ACE_PROVISIONING_MANAGEMENTPARTNER_API_KEY
---
# ACE Provisioning ManagementPartner API
API version: 2018-02-01
## Auth
OAuth2
## Base URL
https://management.azure.com
## Setup
1. Configure auth: OAuth2
2. GET /providers/Microsoft.ManagementPartner/operations -- verify access
## Endpoints
6 endpoints across 1 groups. See references/api-spec.lap for full details.
### providers
| Method | Path | Description |
|--------|------|-------------|
| GET | /providers/Microsoft.ManagementPartner/partners/{partnerId} | Get a specific `Partner`. |
| PUT | /providers/Microsoft.ManagementPartner/partners/{partnerId} | Create a specific `Partner`. |
| PATCH | /providers/Microsoft.ManagementPartner/partners/{partnerId} | Update a specific `Partner`. |
| DELETE | /providers/Microsoft.ManagementPartner/partners/{partnerId} | Delete a specific `Partner`. |
| GET | /providers/Microsoft.ManagementPartner/operations | Get operations. |
| GET | /providers/Microsoft.ManagementPartner/partners | Get a specific `Partner`. |
## Common Questions
Match user requests to endpoints in references/api-spec.lap. Key patterns:
- "Get partner details?" -> GET /providers/Microsoft.ManagementPartner/partners/{partnerId}
- "Update a partner?" -> PUT /providers/Microsoft.ManagementPartner/partners/{partnerId}
- "Partially update a partner?" -> PATCH /providers/Microsoft.ManagementPartner/partners/{partnerId}
- "Delete a partner?" -> DELETE /providers/Microsoft.ManagementPartner/partners/{partnerId}
- "List all operations?" -> GET /providers/Microsoft.ManagementPartner/operations
- "List all partners?" -> GET /providers/Microsoft.ManagementPartner/partners
- "How to authenticate?" -> See Auth section
## Response Tips
- Check response schemas in references/api-spec.lap for field details
- Create/update endpoints typically return the created/updated object
## CLI
```bash
# Update this spec to the latest version
npx @lap-platform/lapsh get ace-provisioning-managementpartner-api -o references/api-spec.lap
# Search for related APIs
npx @lap-platform/lapsh search ace-provisioning-managementpartner-api
```
## References
- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas
> Generated from the official API spec by [LAP](https://lap.sh)
Accounting API skill. Use when working with Accounting for companies. Covers 135 endpoints.
---
name: lap-accounting-api
description: "Accounting API skill. Use when working with Accounting for companies. Covers 135 endpoints."
version: 1.0.0
generator: lapsh
metadata:
openclaw:
requires:
env:
- ACCOUNTING_API_KEY
---
# Accounting API
API version: 3.0.0
## Auth
ApiKey Authorization in header
## Base URL
https://api.codat.io
## Setup
1. Set your API key in the appropriate header
2. GET /companies/{companyId}/connections/{connectionId}/data/accountTransactions -- verify access
3. POST /companies/{companyId}/connections/{connectionId}/push/accounts -- create first accounts
## Endpoints
135 endpoints across 1 groups. See references/api-spec.lap for full details.
### companies
| Method | Path | Description |
|--------|------|-------------|
| GET | /companies/{companyId}/connections/{connectionId}/data/accountTransactions | List account transactions |
| GET | /companies/{companyId}/connections/{connectionId}/data/accountTransactions/{accountTransactionId} | Get account transaction |
| GET | /companies/{companyId}/data/accounts | List accounts |
| GET | /companies/{companyId}/data/accounts/{accountId} | Get account |
| GET | /companies/{companyId}/connections/{connectionId}/options/chartOfAccounts | Get create account model |
| POST | /companies/{companyId}/connections/{connectionId}/push/accounts | Create account |
| GET | /companies/{companyId}/data/billCreditNotes | List bill credit notes |
| GET | /companies/{companyId}/data/billCreditNotes/{billCreditNoteId} | Get bill credit note |
| GET | /companies/{companyId}/connections/{connectionId}/options/billCreditNotes | Get create/update bill credit note model |
| POST | /companies/{companyId}/connections/{connectionId}/push/billCreditNotes | Create bill credit note |
| PUT | /companies/{companyId}/connections/{connectionId}/push/billCreditNotes/{billCreditNoteId} | Update bill credit note |
| POST | /companies/{companyId}/connections/{connectionId}/push/billCreditNotes/{billCreditNoteId}/attachment | Upload bill credit note attachment |
| GET | /companies/{companyId}/data/billPayments | List bill payments |
| GET | /companies/{companyId}/data/billPayments/{billPaymentId} | Get bill payment |
| POST | /companies/{companyId}/connections/{connectionId}/push/billPayments | Create bill payments |
| GET | /companies/{companyId}/connections/{connectionId}/options/billPayments | Get create bill payment model |
| DELETE | /companies/{companyId}/connections/{connectionId}/push/billPayments/{billPaymentId} | Delete bill payment |
| GET | /companies/{companyId}/data/bills | List bills |
| GET | /companies/{companyId}/data/bills/{billId} | Get bill |
| GET | /companies/{companyId}/connections/{connectionId}/options/bills | Get create/update bill model |
| POST | /companies/{companyId}/connections/{connectionId}/push/bills | Create bill |
| PUT | /companies/{companyId}/connections/{connectionId}/push/bills/{billId} | Update bill |
| DELETE | /companies/{companyId}/connections/{connectionId}/push/bills/{billId} | Delete bill |
| GET | /companies/{companyId}/connections/{connectionId}/data/bills/{billId}/attachments | List bill attachments |
| GET | /companies/{companyId}/connections/{connectionId}/data/bills/{billId}/attachments/{attachmentId} | Get bill attachment |
| GET | /companies/{companyId}/connections/{connectionId}/data/bills/{billId}/attachments/{attachmentId}/download | Download bill attachment |
| POST | /companies/{companyId}/connections/{connectionId}/push/bills/{billId}/attachments | Upload bill attachment |
| GET | /companies/{companyId}/data/creditNotes | List credit notes |
| GET | /companies/{companyId}/data/creditNotes/{creditNoteId} | Get credit note |
| GET | /companies/{companyId}/connections/{connectionId}/options/creditNotes | Get create/update credit note model |
| POST | /companies/{companyId}/connections/{connectionId}/push/creditNotes | Create credit note |
| PUT | /companies/{companyId}/connections/{connectionId}/push/creditNotes/{creditNoteId} | Update credit note |
| GET | /companies/{companyId}/data/customers | List customers |
| GET | /companies/{companyId}/data/customers/{customerId} | Get customer |
| GET | /companies/{companyId}/connections/{connectionId}/options/customers | Get create/update customer model |
| POST | /companies/{companyId}/connections/{connectionId}/push/customers | Create customer |
| PUT | /companies/{companyId}/connections/{connectionId}/push/customers/{customerId} | Update customer |
| GET | /companies/{companyId}/connections/{connectionId}/data/customers/{customerId}/attachments | List customer attachments |
| GET | /companies/{companyId}/connections/{connectionId}/data/customers/{customerId}/attachments/{attachmentId} | Get customer attachment |
| GET | /companies/{companyId}/connections/{connectionId}/data/customers/{customerId}/attachments/{attachmentId}/download | Download customer attachment |
| GET | /companies/{companyId}/connections/{connectionId}/data/directCosts | List direct costs |
| GET | /companies/{companyId}/connections/{connectionId}/data/directCosts/{directCostId} | Get direct cost |
| GET | /companies/{companyId}/connections/{connectionId}/options/directCosts | Get create direct cost model |
| POST | /companies/{companyId}/connections/{connectionId}/push/directCosts | Create direct cost |
| DELETE | /companies/{companyId}/connections/{connectionId}/push/directCosts/{directCostId} | Delete direct cost |
| POST | /companies/{companyId}/connections/{connectionId}/push/directCosts/{directCostId}/attachment | Upload direct cost attachment |
| GET | /companies/{companyId}/connections/{connectionId}/data/directCosts/{directCostId}/attachments/{attachmentId} | Get direct cost attachment |
| GET | /companies/{companyId}/connections/{connectionId}/data/directCosts/{directCostId}/attachments/{attachmentId}/download | Download direct cost attachment |
| GET | /companies/{companyId}/connections/{connectionId}/data/directCosts/{directCostId}/attachments | List direct cost attachments |
| GET | /companies/{companyId}/connections/{connectionId}/data/directIncomes | List direct incomes |
| GET | /companies/{companyId}/connections/{connectionId}/data/directIncomes/{directIncomeId} | Get direct income |
| GET | /companies/{companyId}/connections/{connectionId}/options/directIncomes | Get create direct income model |
| POST | /companies/{companyId}/connections/{connectionId}/push/directIncomes | Create direct income |
| POST | /companies/{companyId}/connections/{connectionId}/push/directIncomes/{directIncomeId}/attachment | Create direct income attachment |
| GET | /companies/{companyId}/connections/{connectionId}/data/directIncomes/{directIncomeId}/attachments/{attachmentId} | Get direct income attachment |
| GET | /companies/{companyId}/connections/{connectionId}/data/directIncomes/{directIncomeId}/attachments/{attachmentId}/download | Download direct income attachment |
| GET | /companies/{companyId}/connections/{connectionId}/data/directIncomes/{directIncomeId}/attachments | List direct income attachments |
| GET | /companies/{companyId}/data/financials/balanceSheet | Get balance sheet |
| GET | /companies/{companyId}/data/financials/profitAndLoss | Get profit and loss |
| GET | /companies/{companyId}/data/financials/cashFlowStatement | Get cash flow statement |
| GET | /companies/{companyId}/data/info | Get company info |
| POST | /companies/{companyId}/data/info | Refresh company info |
| GET | /companies/{companyId}/data/invoices | List invoices |
| GET | /companies/{companyId}/data/invoices/{invoiceId} | Get invoice |
| GET | /companies/{companyId}/data/invoices/{invoiceId}/pdf | Get invoice as PDF |
| GET | /companies/{companyId}/connections/{connectionId}/data/invoices/{invoiceId}/attachments | List invoice attachments |
| GET | /companies/{companyId}/connections/{connectionId}/data/invoices/{invoiceId}/attachments/{attachmentId} | Get invoice attachment |
| GET | /companies/{companyId}/connections/{connectionId}/data/invoices/{invoiceId}/attachments/{attachmentId}/download | Download invoice attachment |
| GET | /companies/{companyId}/connections/{connectionId}/options/invoices | Get create/update invoice model |
| POST | /companies/{companyId}/connections/{connectionId}/push/invoices | Create invoice |
| PUT | /companies/{companyId}/connections/{connectionId}/push/invoices/{invoiceId} | Update invoice |
| DELETE | /companies/{companyId}/connections/{connectionId}/push/invoices/{invoiceId} | Delete invoice |
| POST | /companies/{companyId}/connections/{connectionId}/push/invoices/{invoiceId}/attachment | Upload invoice attachment |
| GET | /companies/{companyId}/connections/{connectionId}/data/itemReceipts | List item receipts |
| GET | /companies/{companyId}/connections/{connectionId}/data/itemReceipts/{itemReceiptId} | Get item receipt |
| GET | /companies/{companyId}/data/items | List items |
| GET | /companies/{companyId}/data/items/{itemId} | Get item |
| GET | /companies/{companyId}/connections/{connectionId}/options/items | Get create item model |
| POST | /companies/{companyId}/connections/{connectionId}/push/items | Create item |
| GET | /companies/{companyId}/data/journalEntries | List journal entries |
| GET | /companies/{companyId}/data/journalEntries/{journalEntryId} | Get journal entry |
| GET | /companies/{companyId}/connections/{connectionId}/options/journalEntries | Get create journal entry model |
| POST | /companies/{companyId}/connections/{connectionId}/push/journalEntries | Create journal entry |
| DELETE | /companies/{companyId}/connections/{connectionId}/push/journalEntries/{journalEntryId} | Delete journal entry |
| GET | /companies/{companyId}/data/journals | List journals |
| GET | /companies/{companyId}/data/journals/{journalId} | Get journal |
| GET | /companies/{companyId}/connections/{connectionId}/options/journals | Get create journal model |
| POST | /companies/{companyId}/connections/{connectionId}/push/journals | Create journal |
| GET | /companies/{companyId}/data/paymentMethods | List payment methods |
| GET | /companies/{companyId}/data/paymentMethods/{paymentMethodId} | Get payment method |
| GET | /companies/{companyId}/data/payments | List payments |
| GET | /companies/{companyId}/data/payments/{paymentId} | Get payment |
| GET | /companies/{companyId}/connections/{connectionId}/data/payments | List payments |
| GET | /companies/{companyId}/connections/{connectionId}/options/payments | Get create payment model |
| POST | /companies/{companyId}/connections/{connectionId}/push/payments | Create payment |
| GET | /companies/{companyId}/data/purchaseOrders | List purchase orders |
| GET | /companies/{companyId}/data/purchaseOrders/{purchaseOrderId} | Get purchase order |
| GET | /companies/{companyId}/connections/{connectionId}/options/purchaseOrders | Get create/update purchase order model |
| POST | /companies/{companyId}/connections/{connectionId}/push/purchaseOrders | Create purchase order |
| PUT | /companies/{companyId}/connections/{connectionId}/push/purchaseOrders/{purchaseOrderId} | Update purchase order |
| GET | /companies/{companyId}/data/purchaseOrders/{purchaseOrderId}/pdf | Download purchase order as PDF |
| GET | /companies/{companyId}/connections/{connectionId}/data/purchaseOrders/{purchaseOrderId}/attachments | List purchase order attachments |
| GET | /companies/{companyId}/connections/{connectionId}/data/purchaseOrders/{purchaseOrderId}/attachments/{attachmentId} | Get purchase order attachment |
| GET | /companies/{companyId}/connections/{connectionId}/data/purchaseOrders/{purchaseOrderId}/attachments/{attachmentId}/download | Download purchase order attachment |
| GET | /companies/{companyId}/data/salesOrders | List sales orders |
| GET | /companies/{companyId}/data/salesOrders/{salesOrderId} | Get sales order |
| GET | /companies/{companyId}/data/suppliers | List suppliers |
| GET | /companies/{companyId}/data/suppliers/{supplierId} | Get supplier |
| GET | /companies/{companyId}/connections/{connectionId}/options/suppliers | Get create/update supplier model |
| POST | /companies/{companyId}/connections/{connectionId}/push/suppliers | Create supplier |
| PUT | /companies/{companyId}/connections/{connectionId}/push/suppliers/{supplierId} | Update supplier |
| GET | /companies/{companyId}/connections/{connectionId}/data/suppliers/{supplierId}/attachments | List supplier attachments |
| GET | /companies/{companyId}/connections/{connectionId}/data/suppliers/{supplierId}/attachments/{attachmentId} | Get supplier attachment |
| GET | /companies/{companyId}/connections/{connectionId}/data/suppliers/{supplierId}/attachments/{attachmentId}/download | Download supplier attachment |
| GET | /companies/{companyId}/data/taxRates | List all tax rates |
| GET | /companies/{companyId}/data/taxRates/{taxRateId} | Get tax rate |
| GET | /companies/{companyId}/data/trackingCategories | List tracking categories |
| GET | /companies/{companyId}/data/trackingCategories/{trackingCategoryId} | Get tracking categories |
| GET | /companies/{companyId}/connections/{connectionId}/data/transfers | List transfers |
| POST | /companies/{companyId}/connections/{connectionId}/push/transfers/{transferId}/attachment | Upload transfer attachment |
| GET | /companies/{companyId}/connections/{connectionId}/data/transfers/{transferId} | Get transfer |
| GET | /companies/{companyId}/connections/{connectionId}/options/transfers | Get create transfer model |
| POST | /companies/{companyId}/connections/{connectionId}/push/transfers | Create transfer |
| GET | /companies/{companyId}/connections/{connectionId}/data/bankAccounts | List bank accounts |
| GET | /companies/{companyId}/connections/{connectionId}/data/bankAccounts/{accountId} | Get bank account |
| GET | /companies/{companyId}/connections/{connectionId}/options/bankAccounts | Get create/update bank account model |
| POST | /companies/{companyId}/connections/{connectionId}/push/bankAccounts | Create bank account |
| PUT | /companies/{companyId}/connections/{connectionId}/push/bankAccounts/{bankAccountId} | Update bank account |
| GET | /companies/{companyId}/connections/{connectionId}/data/bankAccounts/{accountId}/bankTransactions | List bank account transactions |
| GET | /companies/{companyId}/connections/{connectionId}/options/bankAccounts/{accountId}/bankTransactions | Get create bank account transactions model |
| POST | /companies/{companyId}/connections/{connectionId}/push/bankAccounts/{accountId}/bankTransactions | Create bank account transactions |
| GET | /companies/{companyId}/reports/agedDebtor/available | Aged debtors report available |
| GET | /companies/{companyId}/reports/agedDebtor | Aged debtors report |
| GET | /companies/{companyId}/reports/agedCreditor/available | Aged creditors report available |
| GET | /companies/{companyId}/reports/agedCreditor | Aged creditors report |
## Common Questions
Match user requests to endpoints in references/api-spec.lap. Key patterns:
- "Search accountTransactions?" -> GET /companies/{companyId}/connections/{connectionId}/data/accountTransactions
- "Get accountTransaction details?" -> GET /companies/{companyId}/connections/{connectionId}/data/accountTransactions/{accountTransactionId}
- "Search accounts?" -> GET /companies/{companyId}/data/accounts
- "Get account details?" -> GET /companies/{companyId}/data/accounts/{accountId}
- "List all chartOfAccounts?" -> GET /companies/{companyId}/connections/{connectionId}/options/chartOfAccounts
- "Create a account?" -> POST /companies/{companyId}/connections/{connectionId}/push/accounts
- "Search billCreditNotes?" -> GET /companies/{companyId}/data/billCreditNotes
- "Get billCreditNote details?" -> GET /companies/{companyId}/data/billCreditNotes/{billCreditNoteId}
- "List all billCreditNotes?" -> GET /companies/{companyId}/connections/{connectionId}/options/billCreditNotes
- "Create a billCreditNote?" -> POST /companies/{companyId}/connections/{connectionId}/push/billCreditNotes
- "Update a billCreditNote?" -> PUT /companies/{companyId}/connections/{connectionId}/push/billCreditNotes/{billCreditNoteId}
- "Create a attachment?" -> POST /companies/{companyId}/connections/{connectionId}/push/billCreditNotes/{billCreditNoteId}/attachment
- "Search billPayments?" -> GET /companies/{companyId}/data/billPayments
- "Get billPayment details?" -> GET /companies/{companyId}/data/billPayments/{billPaymentId}
- "Create a billPayment?" -> POST /companies/{companyId}/connections/{connectionId}/push/billPayments
- "List all billPayments?" -> GET /companies/{companyId}/connections/{connectionId}/options/billPayments
- "Delete a billPayment?" -> DELETE /companies/{companyId}/connections/{connectionId}/push/billPayments/{billPaymentId}
- "Search bills?" -> GET /companies/{companyId}/data/bills
- "Get bill details?" -> GET /companies/{companyId}/data/bills/{billId}
- "List all bills?" -> GET /companies/{companyId}/connections/{connectionId}/options/bills
- "Create a bill?" -> POST /companies/{companyId}/connections/{connectionId}/push/bills
- "Update a bill?" -> PUT /companies/{companyId}/connections/{connectionId}/push/bills/{billId}
- "Delete a bill?" -> DELETE /companies/{companyId}/connections/{connectionId}/push/bills/{billId}
- "List all attachments?" -> GET /companies/{companyId}/connections/{connectionId}/data/bills/{billId}/attachments
- "Get attachment details?" -> GET /companies/{companyId}/connections/{connectionId}/data/bills/{billId}/attachments/{attachmentId}
- "List all download?" -> GET /companies/{companyId}/connections/{connectionId}/data/bills/{billId}/attachments/{attachmentId}/download
- "Create a attachment?" -> POST /companies/{companyId}/connections/{connectionId}/push/bills/{billId}/attachments
- "Search creditNotes?" -> GET /companies/{companyId}/data/creditNotes
- "Get creditNote details?" -> GET /companies/{companyId}/data/creditNotes/{creditNoteId}
- "List all creditNotes?" -> GET /companies/{companyId}/connections/{connectionId}/options/creditNotes
- "Create a creditNote?" -> POST /companies/{companyId}/connections/{connectionId}/push/creditNotes
- "Update a creditNote?" -> PUT /companies/{companyId}/connections/{connectionId}/push/creditNotes/{creditNoteId}
- "Search customers?" -> GET /companies/{companyId}/data/customers
- "Get customer details?" -> GET /companies/{companyId}/data/customers/{customerId}
- "List all customers?" -> GET /companies/{companyId}/connections/{connectionId}/options/customers
- "Create a customer?" -> POST /companies/{companyId}/connections/{connectionId}/push/customers
- "Update a customer?" -> PUT /companies/{companyId}/connections/{connectionId}/push/customers/{customerId}
- "List all attachments?" -> GET /companies/{companyId}/connections/{connectionId}/data/customers/{customerId}/attachments
- "Get attachment details?" -> GET /companies/{companyId}/connections/{connectionId}/data/customers/{customerId}/attachments/{attachmentId}
- "List all download?" -> GET /companies/{companyId}/connections/{connectionId}/data/customers/{customerId}/attachments/{attachmentId}/download
- "Search directCosts?" -> GET /companies/{companyId}/connections/{connectionId}/data/directCosts
- "Get directCost details?" -> GET /companies/{companyId}/connections/{connectionId}/data/directCosts/{directCostId}
- "List all directCosts?" -> GET /companies/{companyId}/connections/{connectionId}/options/directCosts
- "Create a directCost?" -> POST /companies/{companyId}/connections/{connectionId}/push/directCosts
- "Delete a directCost?" -> DELETE /companies/{companyId}/connections/{connectionId}/push/directCosts/{directCostId}
- "Create a attachment?" -> POST /companies/{companyId}/connections/{connectionId}/push/directCosts/{directCostId}/attachment
- "Get attachment details?" -> GET /companies/{companyId}/connections/{connectionId}/data/directCosts/{directCostId}/attachments/{attachmentId}
- "List all download?" -> GET /companies/{companyId}/connections/{connectionId}/data/directCosts/{directCostId}/attachments/{attachmentId}/download
- "List all attachments?" -> GET /companies/{companyId}/connections/{connectionId}/data/directCosts/{directCostId}/attachments
- "Search directIncomes?" -> GET /companies/{companyId}/connections/{connectionId}/data/directIncomes
- "Get directIncome details?" -> GET /companies/{companyId}/connections/{connectionId}/data/directIncomes/{directIncomeId}
- "List all directIncomes?" -> GET /companies/{companyId}/connections/{connectionId}/options/directIncomes
- "Create a directIncome?" -> POST /companies/{companyId}/connections/{connectionId}/push/directIncomes
- "Create a attachment?" -> POST /companies/{companyId}/connections/{connectionId}/push/directIncomes/{directIncomeId}/attachment
- "Get attachment details?" -> GET /companies/{companyId}/connections/{connectionId}/data/directIncomes/{directIncomeId}/attachments/{attachmentId}
- "List all download?" -> GET /companies/{companyId}/connections/{connectionId}/data/directIncomes/{directIncomeId}/attachments/{attachmentId}/download
- "List all attachments?" -> GET /companies/{companyId}/connections/{connectionId}/data/directIncomes/{directIncomeId}/attachments
- "List all balanceSheet?" -> GET /companies/{companyId}/data/financials/balanceSheet
- "List all profitAndLoss?" -> GET /companies/{companyId}/data/financials/profitAndLoss
- "List all cashFlowStatement?" -> GET /companies/{companyId}/data/financials/cashFlowStatement
- "List all info?" -> GET /companies/{companyId}/data/info
- "Create a info?" -> POST /companies/{companyId}/data/info
- "Search invoices?" -> GET /companies/{companyId}/data/invoices
- "Get invoice details?" -> GET /companies/{companyId}/data/invoices/{invoiceId}
- "List all pdf?" -> GET /companies/{companyId}/data/invoices/{invoiceId}/pdf
- "List all attachments?" -> GET /companies/{companyId}/connections/{connectionId}/data/invoices/{invoiceId}/attachments
- "Get attachment details?" -> GET /companies/{companyId}/connections/{connectionId}/data/invoices/{invoiceId}/attachments/{attachmentId}
- "List all download?" -> GET /companies/{companyId}/connections/{connectionId}/data/invoices/{invoiceId}/attachments/{attachmentId}/download
- "List all invoices?" -> GET /companies/{companyId}/connections/{connectionId}/options/invoices
- "Create a invoice?" -> POST /companies/{companyId}/connections/{connectionId}/push/invoices
- "Update a invoice?" -> PUT /companies/{companyId}/connections/{connectionId}/push/invoices/{invoiceId}
- "Delete a invoice?" -> DELETE /companies/{companyId}/connections/{connectionId}/push/invoices/{invoiceId}
- "Create a attachment?" -> POST /companies/{companyId}/connections/{connectionId}/push/invoices/{invoiceId}/attachment
- "Search itemReceipts?" -> GET /companies/{companyId}/connections/{connectionId}/data/itemReceipts
- "Get itemReceipt details?" -> GET /companies/{companyId}/connections/{connectionId}/data/itemReceipts/{itemReceiptId}
- "Search items?" -> GET /companies/{companyId}/data/items
- "Get item details?" -> GET /companies/{companyId}/data/items/{itemId}
- "List all items?" -> GET /companies/{companyId}/connections/{connectionId}/options/items
- "Create a item?" -> POST /companies/{companyId}/connections/{connectionId}/push/items
- "Search journalEntries?" -> GET /companies/{companyId}/data/journalEntries
- "Get journalEntry details?" -> GET /companies/{companyId}/data/journalEntries/{journalEntryId}
- "List all journalEntries?" -> GET /companies/{companyId}/connections/{connectionId}/options/journalEntries
- "Create a journalEntry?" -> POST /companies/{companyId}/connections/{connectionId}/push/journalEntries
- "Delete a journalEntry?" -> DELETE /companies/{companyId}/connections/{connectionId}/push/journalEntries/{journalEntryId}
- "Search journals?" -> GET /companies/{companyId}/data/journals
- "Get journal details?" -> GET /companies/{companyId}/data/journals/{journalId}
- "List all journals?" -> GET /companies/{companyId}/connections/{connectionId}/options/journals
- "Create a journal?" -> POST /companies/{companyId}/connections/{connectionId}/push/journals
- "Search paymentMethods?" -> GET /companies/{companyId}/data/paymentMethods
- "Get paymentMethod details?" -> GET /companies/{companyId}/data/paymentMethods/{paymentMethodId}
- "Search payments?" -> GET /companies/{companyId}/data/payments
- "Get payment details?" -> GET /companies/{companyId}/data/payments/{paymentId}
- "Search payments?" -> GET /companies/{companyId}/connections/{connectionId}/data/payments
- "List all payments?" -> GET /companies/{companyId}/connections/{connectionId}/options/payments
- "Create a payment?" -> POST /companies/{companyId}/connections/{connectionId}/push/payments
- "Search purchaseOrders?" -> GET /companies/{companyId}/data/purchaseOrders
- "Get purchaseOrder details?" -> GET /companies/{companyId}/data/purchaseOrders/{purchaseOrderId}
- "List all purchaseOrders?" -> GET /companies/{companyId}/connections/{connectionId}/options/purchaseOrders
- "Create a purchaseOrder?" -> POST /companies/{companyId}/connections/{connectionId}/push/purchaseOrders
- "Update a purchaseOrder?" -> PUT /companies/{companyId}/connections/{connectionId}/push/purchaseOrders/{purchaseOrderId}
- "List all pdf?" -> GET /companies/{companyId}/data/purchaseOrders/{purchaseOrderId}/pdf
- "List all attachments?" -> GET /companies/{companyId}/connections/{connectionId}/data/purchaseOrders/{purchaseOrderId}/attachments
- "Get attachment details?" -> GET /companies/{companyId}/connections/{connectionId}/data/purchaseOrders/{purchaseOrderId}/attachments/{attachmentId}
- "List all download?" -> GET /companies/{companyId}/connections/{connectionId}/data/purchaseOrders/{purchaseOrderId}/attachments/{attachmentId}/download
- "Search salesOrders?" -> GET /companies/{companyId}/data/salesOrders
- "Get salesOrder details?" -> GET /companies/{companyId}/data/salesOrders/{salesOrderId}
- "Search suppliers?" -> GET /companies/{companyId}/data/suppliers
- "Get supplier details?" -> GET /companies/{companyId}/data/suppliers/{supplierId}
- "List all suppliers?" -> GET /companies/{companyId}/connections/{connectionId}/options/suppliers
- "Create a supplier?" -> POST /companies/{companyId}/connections/{connectionId}/push/suppliers
- "Update a supplier?" -> PUT /companies/{companyId}/connections/{connectionId}/push/suppliers/{supplierId}
- "List all attachments?" -> GET /companies/{companyId}/connections/{connectionId}/data/suppliers/{supplierId}/attachments
- "Get attachment details?" -> GET /companies/{companyId}/connections/{connectionId}/data/suppliers/{supplierId}/attachments/{attachmentId}
- "List all download?" -> GET /companies/{companyId}/connections/{connectionId}/data/suppliers/{supplierId}/attachments/{attachmentId}/download
- "Search taxRates?" -> GET /companies/{companyId}/data/taxRates
- "Get taxRate details?" -> GET /companies/{companyId}/data/taxRates/{taxRateId}
- "Search trackingCategories?" -> GET /companies/{companyId}/data/trackingCategories
- "Get trackingCategory details?" -> GET /companies/{companyId}/data/trackingCategories/{trackingCategoryId}
- "Search transfers?" -> GET /companies/{companyId}/connections/{connectionId}/data/transfers
- "Create a attachment?" -> POST /companies/{companyId}/connections/{connectionId}/push/transfers/{transferId}/attachment
- "Get transfer details?" -> GET /companies/{companyId}/connections/{connectionId}/data/transfers/{transferId}
- "List all transfers?" -> GET /companies/{companyId}/connections/{connectionId}/options/transfers
- "Create a transfer?" -> POST /companies/{companyId}/connections/{connectionId}/push/transfers
- "Search bankAccounts?" -> GET /companies/{companyId}/connections/{connectionId}/data/bankAccounts
- "Get bankAccount details?" -> GET /companies/{companyId}/connections/{connectionId}/data/bankAccounts/{accountId}
- "List all bankAccounts?" -> GET /companies/{companyId}/connections/{connectionId}/options/bankAccounts
- "Create a bankAccount?" -> POST /companies/{companyId}/connections/{connectionId}/push/bankAccounts
- "Update a bankAccount?" -> PUT /companies/{companyId}/connections/{connectionId}/push/bankAccounts/{bankAccountId}
- "Search bankTransactions?" -> GET /companies/{companyId}/connections/{connectionId}/data/bankAccounts/{accountId}/bankTransactions
- "List all bankTransactions?" -> GET /companies/{companyId}/connections/{connectionId}/options/bankAccounts/{accountId}/bankTransactions
- "Create a bankTransaction?" -> POST /companies/{companyId}/connections/{connectionId}/push/bankAccounts/{accountId}/bankTransactions
- "List all available?" -> GET /companies/{companyId}/reports/agedDebtor/available
- "List all agedDebtor?" -> GET /companies/{companyId}/reports/agedDebtor
- "List all available?" -> GET /companies/{companyId}/reports/agedCreditor/available
- "List all agedCreditor?" -> GET /companies/{companyId}/reports/agedCreditor
- "How to authenticate?" -> See Auth section
## Response Tips
- Check response schemas in references/api-spec.lap for field details
- List endpoints may support pagination; check for limit, offset, or cursor params
- Create/update endpoints typically return the created/updated object
## CLI
```bash
# Update this spec to the latest version
npx @lap-platform/lapsh get accounting-api -o references/api-spec.lap
# Search for related APIs
npx @lap-platform/lapsh search accounting-api
```
## References
- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas
> Generated from the official API spec by [LAP](https://lap.sh)
Account v1 API skill. Use when working with Account v1 for custom_policy, fulfillment_policy, payment_policy. Covers 37 endpoints.
---
name: lap-account-v1-api
description: "Account v1 API skill. Use when working with Account v1 for custom_policy, fulfillment_policy, payment_policy. Covers 37 endpoints."
version: 1.0.0
generator: lapsh
metadata:
openclaw:
requires:
env:
- ACCOUNT_V1_API_KEY
---
# Account v1 API
API version: v1.9.3
## Auth
OAuth2
## Base URL
https://api.ebay.com/sell/account/v1
## Setup
1. Configure auth: OAuth2
2. GET /custom_policy/ -- verify access
3. POST /custom_policy/ -- create first custom_policy
## Endpoints
37 endpoints across 13 groups. See references/api-spec.lap for full details.
### custom_policy
| Method | Path | Description |
|--------|------|-------------|
| GET | /custom_policy/ | This method retrieves the list of custom policies defined for a seller's account. To limit the returned custom policies, specify the policy_types query parameter. |
| POST | /custom_policy/ | This method creates a new custom policy that specifies the seller's terms for complying with local governmental regulations. Each Custom Policy targets a policyType. Multiple policies may be created as using the following custom policy types:PRODUCT_COMPLIANCE: Product Compliance policies disclose product information as required for regulatory compliance. Note: A maximum of 60 Product Compliance policies per seller may be created.TAKE_BACK: Takeback policies describe the seller's legal obligation to take back a previously purchased item when the buyer purchases a new one. Note: A maximum of 18 Takeback policies per seller may be created.A successful create policy call returns an HTTP status code of 201 Created with the system-generated policy ID included in the Location response header. |
| GET | /custom_policy/{custom_policy_id} | This method retrieves the custom policy specified by the custom_policy_id path parameter. |
| PUT | /custom_policy/{custom_policy_id} | This method updates an existing custom policy specified by the custom_policy_id path parameter. Since this method overwrites the policy's name, label, and description fields, always include the complete and current text of all three policy fields in the request payload, even if they are not being updated. For example, the value for the label field is to be updated, but the name and description values will remain unchanged. The existing name and description values, as they are defined in the current policy, must also be passed in. A successful policy update call returns an HTTP status code of 204 No Content. |
### fulfillment_policy
| Method | Path | Description |
|--------|------|-------------|
| POST | /fulfillment_policy/ | This method creates a new fulfillment policy for an eBay marketplace where the policy encapsulates seller's terms for fulfilling item purchases. Fulfillment policies include the shipment options that the seller offers to buyers. A successful request returns the getFulfillmentPolicy URI to the new policy in the Location response header and the ID for the new policy is returned in the response payload. Tip: For details on creating and using the business policies supported by the Account API, see eBay business policies. |
| GET | /fulfillment_policy/{fulfillmentPolicyId} | This method retrieves the complete details of a fulfillment policy. Supply the ID of the policy you want to retrieve using the fulfillmentPolicyId path parameter. |
| PUT | /fulfillment_policy/{fulfillmentPolicyId} | This method updates an existing fulfillment policy. Specify the policy you want to update using the fulfillment_policy_id path parameter. Supply a complete policy payload with the updates you want to make; this call overwrites the existing policy with the new details specified in the payload. |
| DELETE | /fulfillment_policy/{fulfillmentPolicyId} | This method deletes a fulfillment policy. Supply the ID of the policy you want to delete in the fulfillmentPolicyId path parameter. |
| GET | /fulfillment_policy | This method retrieves all the fulfillment policies configured for the marketplace you specify using the marketplace_id query parameter. |
| GET | /fulfillment_policy/get_by_policy_name | This method retrieves the details for a specific fulfillment policy. In the request, supply both the policy name and its associated marketplace_id as query parameters. |
### payment_policy
| Method | Path | Description |
|--------|------|-------------|
| GET | /payment_policy | This method retrieves all the payment business policies configured for the marketplace you specify using the marketplace_id query parameter. |
| POST | /payment_policy | This method creates a new payment policy where the policy encapsulates seller's terms for order payments. A successful request returns the getPaymentPolicy URI to the new policy in the Location response header and the ID for the new policy is returned in the response payload. Tip: For details on creating and using the business policies supported by the Account API, see eBay business policies. |
| GET | /payment_policy/{payment_policy_id} | This method retrieves the complete details of a payment policy. Supply the ID of the policy you want to retrieve using the paymentPolicyId path parameter. |
| PUT | /payment_policy/{payment_policy_id} | This method updates an existing payment policy. Specify the policy you want to update using the payment_policy_id path parameter. Supply a complete policy payload with the updates you want to make; this call overwrites the existing policy with the new details specified in the payload. |
| DELETE | /payment_policy/{payment_policy_id} | This method deletes a payment policy. Supply the ID of the policy you want to delete in the paymentPolicyId path parameter. |
| GET | /payment_policy/get_by_policy_name | This method retrieves the details of a specific payment policy. Supply both the policy name and its associated marketplace_id in the request query parameters. |
### payments_program
| Method | Path | Description |
|--------|------|-------------|
| GET | /payments_program/{marketplace_id}/{payments_program_type} | Note: This method is no longer applicable, as all seller accounts globally have been enabled for the new eBay payment and checkout flow.This method returns whether or not the user is opted-in to the specified payments program. Sellers opt-in to payments programs by marketplace and you use the marketplace_id path parameter to specify the marketplace of the status flag you want returned. |
| GET | /payments_program/{marketplace_id}/{payments_program_type}/onboarding | Note: This method is no longer applicable, as all seller accounts globally have been enabled for the new eBay payment and checkout flow.This method retrieves a seller's onboarding status for a payments program for a specified marketplace. The overall onboarding status of the seller and the status of each onboarding step is returned. |
### privilege
| Method | Path | Description |
|--------|------|-------------|
| GET | /privilege | This method retrieves the seller's current set of privileges, including whether or not the seller's eBay registration has been completed, as well as the details of their site-wide sellingLimit (the amount and quantity they can sell on a given day). |
### program
| Method | Path | Description |
|--------|------|-------------|
| GET | /program/get_opted_in_programs | This method gets a list of the seller programs that the seller has opted-in to. |
| POST | /program/opt_in | This method opts the seller in to an eBay seller program. Refer to the Account API overview for information about available eBay seller programs.Note: It can take up to 24-hours for eBay to process your request to opt-in to a Seller Program. Use the getOptedInPrograms call to check the status of your request after the processing period has passed. |
| POST | /program/opt_out | This method opts the seller out of a seller program in which they are currently opted in to. A seller can retrieve a list of the seller programs they are opted-in to using the getOptedInPrograms method. |
### rate_table
| Method | Path | Description |
|--------|------|-------------|
| GET | /rate_table | This method retrieves a seller's shipping rate tables for the country specified in the country_code query parameter. If you call this method without specifying a country code, the call returns all of the seller's shipping rate tables. The method's response includes a rateTableId for each table defined by the seller. This rateTableId value is used in add/revise item call or in create/update fulfillment business policy call to specify the shipping rate table to use for that policy's domestic or international shipping options. This call currently supports getting rate tables related to the following marketplaces: United States, Canada, United Kingdom, Germany, Australia, France, Italy, and Spain. Note: Rate tables created with the Trading API might not have been assigned a rateTableId at the time of their creation. This method can assign and return rateTableId values for rate tables with missing IDs if you make a request using the country_code where the seller has defined rate tables. Sellers can define up to 40 shipping rate tables for their account, which lets them set up different rate tables for each of the marketplaces they sell into. Go to Shipping rate tables in My eBay to create and update rate tables. |
### return_policy
| Method | Path | Description |
|--------|------|-------------|
| GET | /return_policy | This method retrieves all the return policies configured for the marketplace you specify using the marketplace_id query parameter. |
| POST | /return_policy | This method creates a new return policy where the policy encapsulates seller's terms for returning items. Each policy targets a specific marketplace, and you can create multiple policies for each marketplace. Return policies are not applicable to motor-vehicle listings.A successful request returns the getReturnPolicy URI to the new policy in the Location response header and the ID for the new policy is returned in the response payload. Tip: For details on creating and using the business policies supported by the Account API, see eBay business policies. |
| GET | /return_policy/{return_policy_id} | This method retrieves the complete details of the return policy specified by the returnPolicyId path parameter. |
| PUT | /return_policy/{return_policy_id} | This method updates an existing return policy. Specify the policy you want to update using the return_policy_id path parameter. Supply a complete policy payload with the updates you want to make; this call overwrites the existing policy with the new details specified in the payload. |
| DELETE | /return_policy/{return_policy_id} | This method deletes a return policy. Supply the ID of the policy you want to delete in the returnPolicyId path parameter. |
| GET | /return_policy/get_by_policy_name | This method retrieves the details of a specific return policy. Supply both the policy name and its associated marketplace_id in the request query parameters. |
### bulk_create_or_replace_sales_tax
| Method | Path | Description |
|--------|------|-------------|
| POST | /bulk_create_or_replace_sales_tax | This method creates or updates multiple sales-tax table entries.Sales-tax tables can be set up for countries that support different tax jurisdictions.Note: Sales-tax tables are only available for the US (EBAY_US) and Canada (EBAY_CA) marketplaces.Each sales-tax table entry comprises the following parameters:countryCodejurisdictionIdsalesTaxPercentageshippingAndHandlingTaxedValid jurisdiction IDs are retrieved using getSalesTaxJurisdictions in the Metadata API.For details about using this call, refer to Establishing sales-tax tables.Important! ">Important! In the US, eBay now calculates, collects, and remits sales tax to the proper taxing authorities in all 50 states and Washington, DC. Sellers can no longer specify sales-tax rates for these jurisdictions using a tax table.However, sellers may continue to use a sales-tax table to set rates for the following US territories:American Samoa (AS)Guam (GU)Northern Mariana Islands (MP)Palau (PW)US Virgin Islands (VI)For additional information, refer to Taxes and import charges. |
### sales_tax
| Method | Path | Description |
|--------|------|-------------|
| GET | /sales_tax/{countryCode}/{jurisdictionId} | This call retrieves the current sales-tax table entry for a specific tax jurisdiction. Specify the jurisdiction to retrieve using the countryCode and jurisdictionId path parameters. All four response fields will be returned if a sales-tax entry exists for the tax jurisdiction. Otherwise, the response will be returned as empty.Note: Sales-tax tables are only available for the US (EBAY_US) and Canada (EBAY_CA) marketplaces.Important! ">Important! In the US, eBay now calculates, collects, and remits sales tax to the proper taxing authorities in all 50 states and Washington, DC. Sellers can no longer specify sales-tax rates for these jurisdictions using a tax table.However, sellers may continue to use a sales-tax table to set rates for the following US territories:American Samoa (AS)Guam (GU)Northern Mariana Islands (MP)Palau (PW)US Virgin Islands (VI)For additional information, refer to Taxes and import charges. |
| PUT | /sales_tax/{countryCode}/{jurisdictionId} | This method creates or updates a sales-tax table entry for a jurisdiction. Specify the tax table entry you want to configure using the two path parameters: countryCode and jurisdictionId. A tax table entry for a jurisdiction is comprised of two fields: one for the jurisdiction's sales-tax rate and another that's a boolean value indicating whether or not shipping and handling are taxed in the jurisdiction.You can set up sales-tax tables for countries that support different tax jurisdictions.Note: Sales-tax tables are only available for the US (EBAY_US) and Canada (EBAY_CA) marketplaces.Retrieve valid jurisdiction IDs using getSalesTaxJurisdictions in the Metadata API.For details about using this call, refer to Establishing sales-tax tables.Important! ">Important! In the US, eBay now calculates, collects, and remits sales tax to the proper taxing authorities in all 50 states and Washington, DC. Sellers can no longer specify sales-tax rates for these jurisdictions using a tax table.However, sellers may continue to use a sales-tax table to set rates for the following US territories:American Samoa (AS)Guam (GU)Northern Mariana Islands (MP)Palau (PW)US Virgin Islands (VI)For additional information, refer to Taxes and import charges. |
| DELETE | /sales_tax/{countryCode}/{jurisdictionId} | This call deletes a sales-tax table entry for a jurisdiction. Specify the jurisdiction to delete using the countryCode and jurisdictionId path parameters.Note: Sales-tax tables are only available for the US (EBAY_US) and Canada (EBAY_CA) marketplaces. |
| GET | /sales_tax | Use this call to retrieve all sales tax table entries that the seller has defined for a specific country. All four response fields will be returned for each tax jurisdiction that matches the search criteria. If no sales tax rates are defined for the specified, a 204 No Content status code is returned with no response payload.Note: Sales-tax tables are only available for the US (EBAY_US) and Canada (EBAY_CA) marketplaces.Important! ">Important! In the US, eBay now calculates, collects, and remits sales tax to the proper taxing authorities in all 50 states and Washington, DC. Sellers can no longer specify sales-tax rates for these jurisdictions using a tax table.However, sellers may continue to use a sales-tax table to set rates for the following US territories:American Samoa (AS)Guam (GU)Northern Mariana Islands (MP)Palau (PW)US Virgin Islands (VI)For additional information, refer to Taxes and import charges. |
### subscription
| Method | Path | Description |
|--------|------|-------------|
| GET | /subscription | This method retrieves a list of subscriptions associated with the seller account. |
### kyc
| Method | Path | Description |
|--------|------|-------------|
| GET | /kyc | Note: This method was originally created to see which onboarding requirements were still pending for sellers being onboarded for eBay managed payments, but now that all seller accounts are onboarded globally, this method should now just return an empty payload with a 204 No Content HTTP status code. |
### advertising_eligibility
| Method | Path | Description |
|--------|------|-------------|
| GET | /advertising_eligibility | This method allows developers to check the seller eligibility status for eBay advertising programs. |
## Common Questions
Match user requests to endpoints in references/api-spec.lap. Key patterns:
- "List all custom_policy?" -> GET /custom_policy/
- "Create a custom_policy?" -> POST /custom_policy/
- "Get custom_policy details?" -> GET /custom_policy/{custom_policy_id}
- "Update a custom_policy?" -> PUT /custom_policy/{custom_policy_id}
- "Create a fulfillment_policy?" -> POST /fulfillment_policy/
- "Get fulfillment_policy details?" -> GET /fulfillment_policy/{fulfillmentPolicyId}
- "Update a fulfillment_policy?" -> PUT /fulfillment_policy/{fulfillmentPolicyId}
- "Delete a fulfillment_policy?" -> DELETE /fulfillment_policy/{fulfillmentPolicyId}
- "List all fulfillment_policy?" -> GET /fulfillment_policy
- "List all get_by_policy_name?" -> GET /fulfillment_policy/get_by_policy_name
- "List all payment_policy?" -> GET /payment_policy
- "Create a payment_policy?" -> POST /payment_policy
- "Get payment_policy details?" -> GET /payment_policy/{payment_policy_id}
- "Update a payment_policy?" -> PUT /payment_policy/{payment_policy_id}
- "Delete a payment_policy?" -> DELETE /payment_policy/{payment_policy_id}
- "List all get_by_policy_name?" -> GET /payment_policy/get_by_policy_name
- "Get payments_program details?" -> GET /payments_program/{marketplace_id}/{payments_program_type}
- "List all onboarding?" -> GET /payments_program/{marketplace_id}/{payments_program_type}/onboarding
- "List all privilege?" -> GET /privilege
- "List all get_opted_in_programs?" -> GET /program/get_opted_in_programs
- "Create a opt_in?" -> POST /program/opt_in
- "Create a opt_out?" -> POST /program/opt_out
- "List all rate_table?" -> GET /rate_table
- "List all return_policy?" -> GET /return_policy
- "Create a return_policy?" -> POST /return_policy
- "Get return_policy details?" -> GET /return_policy/{return_policy_id}
- "Update a return_policy?" -> PUT /return_policy/{return_policy_id}
- "Delete a return_policy?" -> DELETE /return_policy/{return_policy_id}
- "List all get_by_policy_name?" -> GET /return_policy/get_by_policy_name
- "Create a bulk_create_or_replace_sales_tax?" -> POST /bulk_create_or_replace_sales_tax
- "Get sales_tax details?" -> GET /sales_tax/{countryCode}/{jurisdictionId}
- "Update a sales_tax?" -> PUT /sales_tax/{countryCode}/{jurisdictionId}
- "Delete a sales_tax?" -> DELETE /sales_tax/{countryCode}/{jurisdictionId}
- "List all sales_tax?" -> GET /sales_tax
- "List all subscription?" -> GET /subscription
- "List all kyc?" -> GET /kyc
- "List all advertising_eligibility?" -> GET /advertising_eligibility
- "How to authenticate?" -> See Auth section
## Response Tips
- Check response schemas in references/api-spec.lap for field details
- List endpoints may support pagination; check for limit, offset, or cursor params
- Create/update endpoints typically return the created/updated object
## CLI
```bash
# Update this spec to the latest version
npx @lap-platform/lapsh get account-v1-api -o references/api-spec.lap
# Search for related APIs
npx @lap-platform/lapsh search account-v1-api
```
## References
- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas
> Generated from the official API spec by [LAP](https://lap.sh)
Account Management Overview API skill. Use when working with Account Management Overview for resources. Covers 25 endpoints.
---
name: lap-account-management-overview
description: "Account Management Overview API skill. Use when working with Account Management Overview for resources. Covers 25 endpoints."
version: 1.0.0
generator: lapsh
metadata:
openclaw:
requires:
env:
- ACCOUNT_MANAGEMENT_OVERVIEW_API_KEY
---
# Account Management Overview
API version: 1.0
## Auth
Bearer bearer
## Base URL
https://api.frontegg.com/tenants
## Setup
1. Set Authorization header with your Bearer token
2. GET /resources/tenants/v2 -- verify access
3. POST /resources/tenants/v1 -- create first tenants
## Endpoints
25 endpoints across 1 groups. See references/api-spec.lap for full details.
### resources
| Method | Path | Description |
|--------|------|-------------|
| GET | /resources/tenants/v1/{tenantId} | Get account (tenant) by ID |
| PUT | /resources/tenants/v1/{tenantId} | Update account (tenant) |
| DELETE | /resources/tenants/v1/{tenantId} | Delete account (tenant) |
| POST | /resources/tenants/v1 | Create an account (tenant) |
| DELETE | /resources/tenants/v1 | Delete current account (tenant) |
| POST | /resources/tenants/v1/{tenantId}/metadata | Add account (tenant) metadata |
| DELETE | /resources/tenants/v1/{tenantId}/metadata/{key} | Delete account (tenant) metadata |
| GET | /resources/tenants/v2 | Get accounts (tenants) |
| GET | /resources/tenants/v2/alias/{alias} | Get account (tenant) by alias |
| GET | /resources/tenants/v2/{tenantId} | Get an account (tenant) |
| PUT | /resources/tenants/v2/{tenantId} | Update an account (tenant) |
| POST | /resources/sub-tenants/v1 | Create sub-account |
| PUT | /resources/sub-tenants/v1/{tenantId}/management | Update sub-account (tenant) management |
| PUT | /resources/sub-tenants/v1/{tenantId}/hierarchy-settings | Update sub-account hierarchy settings |
| DELETE | /resources/sub-tenants/v1/{tenantId} | Delete a sub-account by ID |
| GET | /resources/account-settings/v1 | Get account settings |
| PUT | /resources/account-settings/v1 | Update account settings |
| GET | /resources/account-settings/v1/public | Get public settings |
| POST | /resources/migrations/v1/tenants | Migrate accounts (tenants) |
| GET | /resources/migrations/v1/tenants/status/{migrationId} | Accounts (tenants) migration status |
| GET | /resources/hierarchy/v1 | Get sub-accounts (tenants) |
| POST | /resources/hierarchy/v1 | Create sub-account (tenant) |
| DELETE | /resources/hierarchy/v1 | Delete sub-account (tenant) |
| GET | /resources/hierarchy/v1/parents | Get parent accounts (tenants) |
| GET | /resources/hierarchy/v1/tree | Get sub-accounts (tenanants) hierarchy tree |
## Common Questions
Match user requests to endpoints in references/api-spec.lap. Key patterns:
- "Get tenant details?" -> GET /resources/tenants/v1/{tenantId}
- "Update a tenant?" -> PUT /resources/tenants/v1/{tenantId}
- "Delete a tenant?" -> DELETE /resources/tenants/v1/{tenantId}
- "Create a tenant?" -> POST /resources/tenants/v1
- "Create a metadata?" -> POST /resources/tenants/v1/{tenantId}/metadata
- "Delete a metadata?" -> DELETE /resources/tenants/v1/{tenantId}/metadata/{key}
- "List all tenants?" -> GET /resources/tenants/v2
- "Get alia details?" -> GET /resources/tenants/v2/alias/{alias}
- "Get tenant details?" -> GET /resources/tenants/v2/{tenantId}
- "Update a tenant?" -> PUT /resources/tenants/v2/{tenantId}
- "Create a sub-tenant?" -> POST /resources/sub-tenants/v1
- "Delete a sub-tenant?" -> DELETE /resources/sub-tenants/v1/{tenantId}
- "List all account-settings?" -> GET /resources/account-settings/v1
- "List all public?" -> GET /resources/account-settings/v1/public
- "Create a tenant?" -> POST /resources/migrations/v1/tenants
- "Get status details?" -> GET /resources/migrations/v1/tenants/status/{migrationId}
- "List all hierarchy?" -> GET /resources/hierarchy/v1
- "Create a hierarchy?" -> POST /resources/hierarchy/v1
- "List all parents?" -> GET /resources/hierarchy/v1/parents
- "List all tree?" -> GET /resources/hierarchy/v1/tree
- "How to authenticate?" -> See Auth section
## Response Tips
- Check response schemas in references/api-spec.lap for field details
- Create/update endpoints typically return the created/updated object
- Error responses use types: When
## CLI
```bash
# Update this spec to the latest version
npx @lap-platform/lapsh get account-management-overview -o references/api-spec.lap
# Search for related APIs
npx @lap-platform/lapsh search account-management-overview
```
## References
- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas
> Generated from the official API spec by [LAP](https://lap.sh)
Account API skill. Use when working with Account for checkAccountHolder, closeAccount, closeAccountHolder. Covers 20 endpoints.
---
name: lap-account-api
description: "Account API skill. Use when working with Account for checkAccountHolder, closeAccount, closeAccountHolder. Covers 20 endpoints."
version: 1.0.0
generator: lapsh
metadata:
openclaw:
requires:
env:
- ACCOUNT_API_KEY
---
# Account API
API version: 6
## Auth
ApiKey X-API-Key in header | Bearer basic
## Base URL
https://cal-test.adyen.com/cal/services/Account/v6
## Setup
1. Set Authorization header with your Bearer token
3. POST /checkAccountHolder -- create first checkAccountHolder
## Endpoints
20 endpoints across 20 groups. See references/api-spec.lap for full details.
### checkAccountHolder
| Method | Path | Description |
|--------|------|-------------|
| POST | /checkAccountHolder | Trigger verification |
### closeAccount
| Method | Path | Description |
|--------|------|-------------|
| POST | /closeAccount | Close an account |
### closeAccountHolder
| Method | Path | Description |
|--------|------|-------------|
| POST | /closeAccountHolder | Close an account holder |
### closeStores
| Method | Path | Description |
|--------|------|-------------|
| POST | /closeStores | Close stores |
### createAccount
| Method | Path | Description |
|--------|------|-------------|
| POST | /createAccount | Create an account |
### createAccountHolder
| Method | Path | Description |
|--------|------|-------------|
| POST | /createAccountHolder | Create an account holder |
### deleteBankAccounts
| Method | Path | Description |
|--------|------|-------------|
| POST | /deleteBankAccounts | Delete bank accounts |
### deleteLegalArrangements
| Method | Path | Description |
|--------|------|-------------|
| POST | /deleteLegalArrangements | Delete legal arrangements |
### deletePayoutMethods
| Method | Path | Description |
|--------|------|-------------|
| POST | /deletePayoutMethods | Delete payout methods |
### deleteShareholders
| Method | Path | Description |
|--------|------|-------------|
| POST | /deleteShareholders | Delete shareholders |
### deleteSignatories
| Method | Path | Description |
|--------|------|-------------|
| POST | /deleteSignatories | Delete signatories |
### getAccountHolder
| Method | Path | Description |
|--------|------|-------------|
| POST | /getAccountHolder | Get an account holder |
### getTaxForm
| Method | Path | Description |
|--------|------|-------------|
| POST | /getTaxForm | Get a tax form |
### getUploadedDocuments
| Method | Path | Description |
|--------|------|-------------|
| POST | /getUploadedDocuments | Get documents |
### suspendAccountHolder
| Method | Path | Description |
|--------|------|-------------|
| POST | /suspendAccountHolder | Suspend an account holder |
### unSuspendAccountHolder
| Method | Path | Description |
|--------|------|-------------|
| POST | /unSuspendAccountHolder | Unsuspend an account holder |
### updateAccount
| Method | Path | Description |
|--------|------|-------------|
| POST | /updateAccount | Update an account |
### updateAccountHolder
| Method | Path | Description |
|--------|------|-------------|
| POST | /updateAccountHolder | Update an account holder |
### updateAccountHolderState
| Method | Path | Description |
|--------|------|-------------|
| POST | /updateAccountHolderState | Update payout or processing state |
### uploadDocument
| Method | Path | Description |
|--------|------|-------------|
| POST | /uploadDocument | Upload a document |
## Common Questions
Match user requests to endpoints in references/api-spec.lap. Key patterns:
- "Create a checkAccountHolder?" -> POST /checkAccountHolder
- "Create a closeAccount?" -> POST /closeAccount
- "Create a closeAccountHolder?" -> POST /closeAccountHolder
- "Create a closeStore?" -> POST /closeStores
- "Create a createAccount?" -> POST /createAccount
- "Create a createAccountHolder?" -> POST /createAccountHolder
- "Create a deleteBankAccount?" -> POST /deleteBankAccounts
- "Create a deleteLegalArrangement?" -> POST /deleteLegalArrangements
- "Create a deletePayoutMethod?" -> POST /deletePayoutMethods
- "Create a deleteShareholder?" -> POST /deleteShareholders
- "Create a deleteSignatory?" -> POST /deleteSignatories
- "Create a getAccountHolder?" -> POST /getAccountHolder
- "Create a getTaxForm?" -> POST /getTaxForm
- "Create a getUploadedDocument?" -> POST /getUploadedDocuments
- "Create a suspendAccountHolder?" -> POST /suspendAccountHolder
- "Create a unSuspendAccountHolder?" -> POST /unSuspendAccountHolder
- "Create a updateAccount?" -> POST /updateAccount
- "Create a updateAccountHolder?" -> POST /updateAccountHolder
- "Create a updateAccountHolderState?" -> POST /updateAccountHolderState
- "Create a uploadDocument?" -> POST /uploadDocument
- "How to authenticate?" -> See Auth section
## Response Tips
- Check response schemas in references/api-spec.lap for field details
- Create/update endpoints typically return the created/updated object
## CLI
```bash
# Update this spec to the latest version
npx @lap-platform/lapsh get account-api -o references/api-spec.lap
# Search for related APIs
npx @lap-platform/lapsh search account-api
```
## References
- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas
> Generated from the official API spec by [LAP](https://lap.sh)
Account and Transaction API Specification API skill. Use when working with Account and Transaction API Specification for account-access-consents, accounts, b...
---
name: lap-account-and-transaction-api-specification
description: "Account and Transaction API Specification API skill. Use when working with Account and Transaction API Specification for account-access-consents, accounts, balances. Covers 29 endpoints."
version: 1.0.0
generator: lapsh
metadata:
openclaw:
requires:
env:
- ACCOUNT_AND_TRANSACTION_API_SPECIFICATION_API_KEY
---
# Account and Transaction API Specification
API version: 4.0.0
## Auth
OAuth2 | OAuth2
## Base URL
/open-banking/v4.0/aisp
## Setup
1. Configure auth: OAuth2 | OAuth2
2. GET /accounts -- verify access
3. POST /account-access-consents -- create first account-access-consents
## Endpoints
29 endpoints across 12 groups. See references/api-spec.lap for full details.
### account-access-consents
| Method | Path | Description |
|--------|------|-------------|
| POST | /account-access-consents | Create Account Access Consents |
| GET | /account-access-consents/{ConsentId} | Get Account Access Consents |
| DELETE | /account-access-consents/{ConsentId} | Delete Account Access Consents |
### accounts
| Method | Path | Description |
|--------|------|-------------|
| GET | /accounts | Get Accounts |
| GET | /accounts/{AccountId} | Get Accounts |
| GET | /accounts/{AccountId}/balances | Get Balances |
| GET | /accounts/{AccountId}/beneficiaries | Get Beneficiaries |
| GET | /accounts/{AccountId}/direct-debits | Get Direct Debits |
| GET | /accounts/{AccountId}/offers | Get Offers |
| GET | /accounts/{AccountId}/parties | Get Parties |
| GET | /accounts/{AccountId}/party | Get Parties |
| GET | /accounts/{AccountId}/product | Get Products |
| GET | /accounts/{AccountId}/scheduled-payments | Get Scheduled Payments |
| GET | /accounts/{AccountId}/standing-orders | Get Standing Orders |
| GET | /accounts/{AccountId}/statements | Get Statements |
| GET | /accounts/{AccountId}/statements/{StatementId} | Get Statements |
| GET | /accounts/{AccountId}/statements/{StatementId}/file | Get Statements |
| GET | /accounts/{AccountId}/statements/{StatementId}/transactions | Get Transactions |
| GET | /accounts/{AccountId}/transactions | Get Transactions |
### balances
| Method | Path | Description |
|--------|------|-------------|
| GET | /balances | Get Balances |
### beneficiaries
| Method | Path | Description |
|--------|------|-------------|
| GET | /beneficiaries | Get Beneficiaries |
### direct-debits
| Method | Path | Description |
|--------|------|-------------|
| GET | /direct-debits | Get Direct Debits |
### offers
| Method | Path | Description |
|--------|------|-------------|
| GET | /offers | Get Offers |
### party
| Method | Path | Description |
|--------|------|-------------|
| GET | /party | Get Parties |
### products
| Method | Path | Description |
|--------|------|-------------|
| GET | /products | Get Products |
### scheduled-payments
| Method | Path | Description |
|--------|------|-------------|
| GET | /scheduled-payments | Get Scheduled Payments |
### standing-orders
| Method | Path | Description |
|--------|------|-------------|
| GET | /standing-orders | Get Standing Orders |
### statements
| Method | Path | Description |
|--------|------|-------------|
| GET | /statements | Get Statements |
### transactions
| Method | Path | Description |
|--------|------|-------------|
| GET | /transactions | Get Transactions |
## Common Questions
Match user requests to endpoints in references/api-spec.lap. Key patterns:
- "Create a account-access-consent?" -> POST /account-access-consents
- "Get account-access-consent details?" -> GET /account-access-consents/{ConsentId}
- "Delete a account-access-consent?" -> DELETE /account-access-consents/{ConsentId}
- "List all accounts?" -> GET /accounts
- "Get account details?" -> GET /accounts/{AccountId}
- "List all balances?" -> GET /accounts/{AccountId}/balances
- "List all beneficiaries?" -> GET /accounts/{AccountId}/beneficiaries
- "List all direct-debits?" -> GET /accounts/{AccountId}/direct-debits
- "List all offers?" -> GET /accounts/{AccountId}/offers
- "List all parties?" -> GET /accounts/{AccountId}/parties
- "List all party?" -> GET /accounts/{AccountId}/party
- "List all product?" -> GET /accounts/{AccountId}/product
- "List all scheduled-payments?" -> GET /accounts/{AccountId}/scheduled-payments
- "List all standing-orders?" -> GET /accounts/{AccountId}/standing-orders
- "List all statements?" -> GET /accounts/{AccountId}/statements
- "Get statement details?" -> GET /accounts/{AccountId}/statements/{StatementId}
- "List all file?" -> GET /accounts/{AccountId}/statements/{StatementId}/file
- "List all transactions?" -> GET /accounts/{AccountId}/statements/{StatementId}/transactions
- "List all transactions?" -> GET /accounts/{AccountId}/transactions
- "List all balances?" -> GET /balances
- "List all beneficiaries?" -> GET /beneficiaries
- "List all direct-debits?" -> GET /direct-debits
- "List all offers?" -> GET /offers
- "List all party?" -> GET /party
- "List all products?" -> GET /products
- "List all scheduled-payments?" -> GET /scheduled-payments
- "List all standing-orders?" -> GET /standing-orders
- "List all statements?" -> GET /statements
- "List all transactions?" -> GET /transactions
- "How to authenticate?" -> See Auth section
## Response Tips
- Check response schemas in references/api-spec.lap for field details
- Create/update endpoints typically return the created/updated object
## CLI
```bash
# Update this spec to the latest version
npx @lap-platform/lapsh get account-and-transaction-api-specification -o references/api-spec.lap
# Search for related APIs
npx @lap-platform/lapsh search account-and-transaction-api-specification
```
## References
- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas
> Generated from the official API spec by [LAP](https://lap.sh)
Access Analyzer API skill. Use when working with Access Analyzer for archive-rule, policy, access-preview. Covers 35 endpoints.
---
name: lap-access-analyzer
description: "Access Analyzer API skill. Use when working with Access Analyzer for archive-rule, policy, access-preview. Covers 35 endpoints."
version: 1.0.0
generator: lapsh
metadata:
openclaw:
requires:
env:
- ACCESS_ANALYZER_API_KEY
---
# Access Analyzer
API version: 2019-11-01
## Auth
AWS SigV4
## Base URL
Not specified.
## Setup
1. Configure auth: AWS SigV4
2. GET /analyzed-resource -- verify access
3. POST /policy/check-access-not-granted -- create first check-access-not-granted
## Endpoints
35 endpoints across 10 groups. See references/api-spec.lap for full details.
### archive-rule
| Method | Path | Description |
|--------|------|-------------|
| PUT | /archive-rule | Retroactively applies the archive rule to existing findings that meet the archive rule criteria. |
### policy
| Method | Path | Description |
|--------|------|-------------|
| PUT | /policy/generation/{jobId} | Cancels the requested policy generation. |
| POST | /policy/check-access-not-granted | Checks whether the specified access isn't allowed by a policy. |
| POST | /policy/check-no-new-access | Checks whether new access is allowed for an updated policy when compared to the existing policy. You can find examples for reference policies and learn how to set up and run a custom policy check for new access in the IAM Access Analyzer custom policy checks samples repository on GitHub. The reference policies in this repository are meant to be passed to the existingPolicyDocument request parameter. |
| POST | /policy/check-no-public-access | Checks whether a resource policy can grant public access to the specified resource type. |
| GET | /policy/generation/{jobId} | Retrieves the policy that was generated using StartPolicyGeneration. |
| GET | /policy/generation | Lists all of the policy generations requested in the last seven days. |
| PUT | /policy/generation | Starts the policy generation request. |
| POST | /policy/validation | Requests the validation of a policy and returns a list of findings. The findings help you identify issues and provide actionable recommendations to resolve the issue and enable you to author functional policies that meet security best practices. |
### access-preview
| Method | Path | Description |
|--------|------|-------------|
| PUT | /access-preview | Creates an access preview that allows you to preview IAM Access Analyzer findings for your resource before deploying resource permissions. |
| GET | /access-preview/{accessPreviewId} | Retrieves information about an access preview for the specified analyzer. |
| POST | /access-preview/{accessPreviewId} | Retrieves a list of access preview findings generated by the specified access preview. |
| GET | /access-preview | Retrieves a list of access previews for the specified analyzer. |
### analyzer
| Method | Path | Description |
|--------|------|-------------|
| PUT | /analyzer | Creates an analyzer for your account. |
| PUT | /analyzer/{analyzerName}/archive-rule | Creates an archive rule for the specified analyzer. Archive rules automatically archive new findings that meet the criteria you define when you create the rule. To learn about filter keys that you can use to create an archive rule, see IAM Access Analyzer filter keys in the IAM User Guide. |
| DELETE | /analyzer/{analyzerName} | Deletes the specified analyzer. When you delete an analyzer, IAM Access Analyzer is disabled for the account or organization in the current or specific Region. All findings that were generated by the analyzer are deleted. You cannot undo this action. |
| DELETE | /analyzer/{analyzerName}/archive-rule/{ruleName} | Deletes the specified archive rule. |
| GET | /analyzer/{analyzerName} | Retrieves information about the specified analyzer. |
| GET | /analyzer/{analyzerName}/archive-rule/{ruleName} | Retrieves information about an archive rule. To learn about filter keys that you can use to create an archive rule, see IAM Access Analyzer filter keys in the IAM User Guide. |
| GET | /analyzer | Retrieves a list of analyzers. |
| GET | /analyzer/{analyzerName}/archive-rule | Retrieves a list of archive rules created for the specified analyzer. |
| PUT | /analyzer/{analyzerName}/archive-rule/{ruleName} | Updates the criteria and values for the specified archive rule. |
### recommendation
| Method | Path | Description |
|--------|------|-------------|
| POST | /recommendation/{id} | Creates a recommendation for an unused permissions finding. |
| GET | /recommendation/{id} | Retrieves information about a finding recommendation for the specified analyzer. |
### analyzed-resource
| Method | Path | Description |
|--------|------|-------------|
| GET | /analyzed-resource | Retrieves information about a resource that was analyzed. |
| POST | /analyzed-resource | Retrieves a list of resources of the specified type that have been analyzed by the specified external access analyzer. This action is not supported for unused access analyzers. |
### finding
| Method | Path | Description |
|--------|------|-------------|
| GET | /finding/{id} | Retrieves information about the specified finding. GetFinding and GetFindingV2 both use access-analyzer:GetFinding in the Action element of an IAM policy statement. You must have permission to perform the access-analyzer:GetFinding action. |
| POST | /finding | Retrieves a list of findings generated by the specified analyzer. ListFindings and ListFindingsV2 both use access-analyzer:ListFindings in the Action element of an IAM policy statement. You must have permission to perform the access-analyzer:ListFindings action. To learn about filter keys that you can use to retrieve a list of findings, see IAM Access Analyzer filter keys in the IAM User Guide. |
| PUT | /finding | Updates the status for the specified findings. |
### findingv2
| Method | Path | Description |
|--------|------|-------------|
| GET | /findingv2/{id} | Retrieves information about the specified finding. GetFinding and GetFindingV2 both use access-analyzer:GetFinding in the Action element of an IAM policy statement. You must have permission to perform the access-analyzer:GetFinding action. |
| POST | /findingv2 | Retrieves a list of findings generated by the specified analyzer. ListFindings and ListFindingsV2 both use access-analyzer:ListFindings in the Action element of an IAM policy statement. You must have permission to perform the access-analyzer:ListFindings action. To learn about filter keys that you can use to retrieve a list of findings, see IAM Access Analyzer filter keys in the IAM User Guide. |
### tags
| Method | Path | Description |
|--------|------|-------------|
| GET | /tags/{resourceArn} | Retrieves a list of tags applied to the specified resource. |
| POST | /tags/{resourceArn} | Adds a tag to the specified resource. |
| DELETE | /tags/{resourceArn} | Removes a tag from the specified resource. |
### resource
| Method | Path | Description |
|--------|------|-------------|
| POST | /resource/scan | Immediately starts a scan of the policies applied to the specified resource. |
## Common Questions
Match user requests to endpoints in references/api-spec.lap. Key patterns:
- "Update a generation?" -> PUT /policy/generation/{jobId}
- "Create a check-access-not-granted?" -> POST /policy/check-access-not-granted
- "Create a check-no-new-access?" -> POST /policy/check-no-new-access
- "Create a check-no-public-access?" -> POST /policy/check-no-public-access
- "Delete a analyzer?" -> DELETE /analyzer/{analyzerName}
- "Delete a archive-rule?" -> DELETE /analyzer/{analyzerName}/archive-rule/{ruleName}
- "Get access-preview details?" -> GET /access-preview/{accessPreviewId}
- "List all analyzed-resource?" -> GET /analyzed-resource
- "Get analyzer details?" -> GET /analyzer/{analyzerName}
- "Get archive-rule details?" -> GET /analyzer/{analyzerName}/archive-rule/{ruleName}
- "Get finding details?" -> GET /finding/{id}
- "Get recommendation details?" -> GET /recommendation/{id}
- "Get findingv2 details?" -> GET /findingv2/{id}
- "Get generation details?" -> GET /policy/generation/{jobId}
- "List all access-preview?" -> GET /access-preview
- "Create a analyzed-resource?" -> POST /analyzed-resource
- "List all analyzer?" -> GET /analyzer
- "List all archive-rule?" -> GET /analyzer/{analyzerName}/archive-rule
- "Create a finding?" -> POST /finding
- "Create a findingv2?" -> POST /findingv2
- "List all generation?" -> GET /policy/generation
- "Get tag details?" -> GET /tags/{resourceArn}
- "Create a scan?" -> POST /resource/scan
- "Delete a tag?" -> DELETE /tags/{resourceArn}
- "Update a archive-rule?" -> PUT /analyzer/{analyzerName}/archive-rule/{ruleName}
- "Create a validation?" -> POST /policy/validation
- "How to authenticate?" -> See Auth section
## Response Tips
- Check response schemas in references/api-spec.lap for field details
- Create/update endpoints typically return the created/updated object
## CLI
```bash
# Update this spec to the latest version
npx @lap-platform/lapsh get access-analyzer -o references/api-spec.lap
# Search for related APIs
npx @lap-platform/lapsh search access-analyzer
```
## References
- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas
> Generated from the official API spec by [LAP](https://lap.sh)
Abuse API skill. Use when working with Abuse for abuse. Covers 6 endpoints.
---
name: lap-abuse-api
description: "Abuse API skill. Use when working with Abuse for abuse. Covers 6 endpoints."
version: 1.0.0
generator: lapsh
---
# Abuse API
API version: 2.0.0
## Auth
No authentication required.
## Base URL
https://api.ote-godaddy.com
## Setup
1. No auth setup needed
2. GET /v1/abuse/tickets -- verify access
3. POST /v1/abuse/tickets -- create first tickets
## Endpoints
6 endpoints across 1 groups. See references/api-spec.lap for full details.
### abuse
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/abuse/tickets | List all abuse tickets ids that match user provided filters |
| POST | /v1/abuse/tickets | Create a new abuse ticket |
| GET | /v1/abuse/tickets/{ticketId} | Return the abuse ticket data for a given ticket id |
| GET | /v2/abuse/tickets | List all abuse tickets ids that match user provided filters |
| POST | /v2/abuse/tickets | Create a new abuse ticket |
| GET | /v2/abuse/tickets/{ticketId} | Return the abuse ticket data for a given ticket id |
## Common Questions
Match user requests to endpoints in references/api-spec.lap. Key patterns:
- "List all tickets?" -> GET /v1/abuse/tickets
- "Create a ticket?" -> POST /v1/abuse/tickets
- "Get ticket details?" -> GET /v1/abuse/tickets/{ticketId}
- "List all tickets?" -> GET /v2/abuse/tickets
- "Create a ticket?" -> POST /v2/abuse/tickets
- "Get ticket details?" -> GET /v2/abuse/tickets/{ticketId}
## Response Tips
- Check response schemas in references/api-spec.lap for field details
- List endpoints may support pagination; check for limit, offset, or cursor params
- Create/update endpoints typically return the created/updated object
## CLI
```bash
# Update this spec to the latest version
npx @lap-platform/lapsh get abuse-api -o references/api-spec.lap
# Search for related APIs
npx @lap-platform/lapsh search abuse-api
```
## References
- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas
> Generated from the official API spec by [LAP](https://lap.sh)
1Password Connect API skill. Use when working with 1Password Connect for activity, vaults, heartbeat. Covers 15 endpoints.
---
name: lap-1password-connect
description: "1Password Connect API skill. Use when working with 1Password Connect for activity, vaults, heartbeat. Covers 15 endpoints."
version: 1.0.0
generator: lapsh
metadata:
openclaw:
requires:
env:
- 1PASSWORD_CONNECT_API_KEY
---
# 1Password Connect
API version: 1.5.7
## Auth
Bearer bearer
## Base URL
http://localhost:8080/v1
## Setup
1. Set Authorization header with your Bearer token
2. GET /activity -- verify access
3. POST /vaults/{vaultUuid}/items -- create first items
## Endpoints
15 endpoints across 5 groups. See references/api-spec.lap for full details.
### activity
| Method | Path | Description |
|--------|------|-------------|
| GET | /activity | Retrieve a list of API Requests that have been made. |
### vaults
| Method | Path | Description |
|--------|------|-------------|
| GET | /vaults | Get all Vaults |
| GET | /vaults/{vaultUuid} | Get Vault details and metadata |
| GET | /vaults/{vaultUuid}/items | Get all items for inside a Vault |
| POST | /vaults/{vaultUuid}/items | Create a new Item |
| GET | /vaults/{vaultUuid}/items/{itemUuid} | Get the details of an Item |
| PUT | /vaults/{vaultUuid}/items/{itemUuid} | Update an Item |
| DELETE | /vaults/{vaultUuid}/items/{itemUuid} | Delete an Item |
| PATCH | /vaults/{vaultUuid}/items/{itemUuid} | Update a subset of Item attributes |
| GET | /vaults/{vaultUuid}/items/{itemUuid}/files | Get all the files inside an Item |
| GET | /vaults/{vaultUuid}/items/{itemUuid}/files/{fileUuid} | Get the details of a File |
| GET | /vaults/{vaultUuid}/items/{itemUuid}/files/{fileUuid}/content | Get the content of a File |
### heartbeat
| Method | Path | Description |
|--------|------|-------------|
| GET | /heartbeat | Ping the server for liveness |
### health
| Method | Path | Description |
|--------|------|-------------|
| GET | /health | Get state of the server and its dependencies. |
### metrics
| Method | Path | Description |
|--------|------|-------------|
| GET | /metrics | Query server for exposed Prometheus metrics |
## Common Questions
Match user requests to endpoints in references/api-spec.lap. Key patterns:
- "List all activity?" -> GET /activity
- "List all vaults?" -> GET /vaults
- "Get vault details?" -> GET /vaults/{vaultUuid}
- "List all items?" -> GET /vaults/{vaultUuid}/items
- "Create a item?" -> POST /vaults/{vaultUuid}/items
- "Get item details?" -> GET /vaults/{vaultUuid}/items/{itemUuid}
- "Update a item?" -> PUT /vaults/{vaultUuid}/items/{itemUuid}
- "Delete a item?" -> DELETE /vaults/{vaultUuid}/items/{itemUuid}
- "Partially update a item?" -> PATCH /vaults/{vaultUuid}/items/{itemUuid}
- "List all files?" -> GET /vaults/{vaultUuid}/items/{itemUuid}/files
- "Get file details?" -> GET /vaults/{vaultUuid}/items/{itemUuid}/files/{fileUuid}
- "List all content?" -> GET /vaults/{vaultUuid}/items/{itemUuid}/files/{fileUuid}/content
- "List all heartbeat?" -> GET /heartbeat
- "List all health?" -> GET /health
- "List all metrics?" -> GET /metrics
- "How to authenticate?" -> See Auth section
## Response Tips
- Check response schemas in references/api-spec.lap for field details
- List endpoints may support pagination; check for limit, offset, or cursor params
- Create/update endpoints typically return the created/updated object
## CLI
```bash
# Update this spec to the latest version
npx @lap-platform/lapsh get 1password-connect -o references/api-spec.lap
# Search for related APIs
npx @lap-platform/lapsh search 1password-connect
```
## References
- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas
> Generated from the official API spec by [LAP](https://lap.sh)
1,000,000+ Recipe and Grocery List API (v2) API skill. Use when working with 1,000,000+ Recipe and Grocery List API (v2) for collection, collections, grocery...
---
name: lap-1000000-recipe-and-grocery-list-api-v2
description: "1,000,000+ Recipe and Grocery List API (v2) API skill. Use when working with 1,000,000+ Recipe and Grocery List API (v2) for collection, collections, grocerylist. Covers 66 endpoints."
version: 1.0.0
generator: lapsh
metadata:
openclaw:
requires:
env:
- 1000000_RECIPE_AND_GROCERY_LIST_API_V2_API_KEY
---
# 1,000,000+ Recipe and Grocery List API (v2)
API version: partner
## Auth
basic | ApiKey X-BigOven-API-Key in header
## Base URL
https://api2.bigoven.com
## Setup
1. Set your API key in the appropriate header
2. GET /collections -- verify access
3. POST /grocerylist/department -- create first department
## Endpoints
66 endpoints across 7 groups. See references/api-spec.lap for full details.
### collection
| Method | Path | Description |
|--------|------|-------------|
| GET | /collection/{id} | Gets a recipe collection. A recipe collection is a curated set of recipes. |
| GET | /collection/{id}/meta | Gets a recipe collection metadata. A recipe collection is a curated set of recipes. |
### collections
| Method | Path | Description |
|--------|------|-------------|
| GET | /collections | Get the list of current, seasonal recipe collections. From here, you can use the /collection/{id} endpoint to retrieve the recipes in those collections. |
### grocerylist
| Method | Path | Description |
|--------|------|-------------|
| POST | /grocerylist/department | Departmentalize a list of strings -- used for ad-hoc grocery list item addition |
| GET | /grocerylist | Get the user's grocery list. User is determined by Basic Authentication. |
| DELETE | /grocerylist | Delete all the items on a grocery list; faster operation than a sync with deleted items. |
| POST | /grocerylist/recipe | Add a Recipe to the grocery list. In the request data, pass in recipeId, scale (scale=1.0 says to keep the recipe the same size as originally posted), markAsPending (true/false) to indicate that |
| POST | /grocerylist/line | Add a single line item to the grocery list |
| POST | /grocerylist/item | Add a single line item to the grocery list |
| POST | /grocerylist/sync | Synchronize the grocery list. Call this with a POST to /grocerylist/sync |
| PUT | /grocerylist/item/{guid} | Update a grocery item by GUID |
| DELETE | /grocerylist/item/{guid} | /grocerylist/item/{guid} DELETE will delete this item assuming you own it. |
| POST | /grocerylist/clearcheckedlines | Clears the checked lines. |
### recipe
| Method | Path | Description |
|--------|------|-------------|
| GET | /recipe/{recipeId}/images | Get all the images for a recipe. DEPRECATED. Please use /recipe/{recipeId}/photos. |
| GET | /recipe/photos/pending | Gets the pending by user. |
| GET | /recipe/{recipeId}/photos | Get all the photos for a recipe |
| GET | /recipe/{recipeId}/scans | Gets a list of RecipeScan images for the recipe. There will be at most 3 per recipe. |
| POST | /recipe/{recipeId}/image | POST: /recipe/{recipeId}/image?lat=42&lng=21&caption=this%20is%20my%20caption |
| GET | /recipe/{recipeId}/note/{noteId} | Get a given note. Make sure you're passing authentication information in the header for the user who owns the note. |
| PUT | /recipe/{recipeId}/note/{noteId} | HTTP PUT (update) a Recipe note (RecipeNote). |
| DELETE | /recipe/{recipeId}/note/{noteId} | Delete a review |
| GET | /recipe/{recipeId}/notes | recipe/100/notes |
| POST | /recipe/{recipeId}/note | HTTP POST a new note into the system. |
| GET | /recipe/{id}/zap | Zaps the recipe. |
| GET | /recipe/{id} | Return full Recipe detail. Returns 403 if the recipe is owned by someone else. |
| DELETE | /recipe/{id} | Deletes specified recipe (you must be authenticated as the owner of the recipe) |
| GET | /recipe/steps/{id} | Return full Recipe detail with steps. Returns 403 if the recipe is owned by someone else. |
| POST | /recipe/post/step | Stores recipe step number and returns saved step data |
| POST | /recipe/get/step/number | Returns stored step number and number of steps in recipe |
| GET | /recipe/get/active/recipe | Returns last active recipe for the user |
| POST | /recipe/get/saved/step | Gets recipe single step as text |
| GET | /recipe/{recipeId}/related | Get recipes related to the given recipeId |
| POST | /recipe/{recipeId}/feedback | Feedback on a Recipe -- for internal BigOven editors |
| GET | /recipe/categories | Get a list of recipe categories (the ID field can be used for include_cat in search parameters) |
| GET | /recipe/autocomplete | Given a query, return recipe titles starting with query. Query must be at least 3 chars in length. |
| GET | /recipe/autocomplete/mine | Automatics the complete my recipes. |
| GET | /recipe/autocomplete/all | Automatics the complete all recipes. |
| POST | /recipe/scan | POST an image as a new RecipeScan request |
| PUT | /recipe | Update a recipe |
| POST | /recipe | Add a new recipe |
| GET | /recipe/{recipeId}/review/{reviewId} | Get a given review - DEPRECATED. See recipe/review/{reviewId} for the current usage. |
| PUT | /recipe/{recipeId}/review/{reviewId} | HTTP PUT (update) a recipe review. DEPRECATED. Please see recipe/review/{reviewId} PUT for the new endpoint. |
| DELETE | /recipe/{recipeId}/review/{reviewId} | DEPRECATED! - Deletes a review by recipeId and reviewId. Please use recipe/review/{reviewId} instead. |
| GET | /recipe/review/{reviewId} | Get a given review by string-style ID. This will return a payload with FeaturedReply, ReplyCount. |
| PUT | /recipe/review/{reviewId} | Update a given top-level review. |
| GET | /recipe/{recipeId}/review | Get *my* review for the recipe {recipeId}, where "me" is determined by standard authentication headers |
| POST | /recipe/{recipeId}/review | Add a new review. Only one review can be provided per {userId, recipeId} pair. Otherwise your review will be updated. |
| GET | /recipe/{recipeId}/reviews | Get paged list of reviews for a recipe. Each review will have at most one FeaturedReply, as well as a ReplyCount. |
| GET | /recipe/review/{reviewId}/replies | Get a paged list of replies for a given review. |
| POST | /recipe/review/{reviewId}/replies | POST a reply to a given review. The date will be set by server. Note that replies no longer have star ratings, only top-level reviews do. |
| PUT | /recipe/review/replies/{replyId} | Update (PUT) a reply to a given review. Authenticated user must be the original one that posted the reply. |
| DELETE | /recipe/review/replies/{replyId} | DELETE a reply to a given review. Authenticated user must be the one who originally posted the reply. |
### image
| Method | Path | Description |
|--------|------|-------------|
| POST | /image/avatar | POST: /image/avatar |
### me
| Method | Path | Description |
|--------|------|-------------|
| GET | /me | Indexes this instance. |
| PUT | /me | Puts me. |
| GET | /me/skinny | Skinnies this instance. |
| GET | /me/preferences/options | Gets the options. |
| PUT | /me/profile | Puts me. |
| PUT | /me/personal | Puts me personal. |
| PUT | /me/preferences | Puts me preferences. |
### recipes
| Method | Path | Description |
|--------|------|-------------|
| GET | /recipes/raves | Get the recipe/comment tuples for those recipes with 4 or 5 star ratings |
| GET | /recipes/{id} | Same as GET recipe but also includes the recipe videos (if any) |
| GET | /recipes/random | Get a random, home-page-quality Recipe. |
| GET | /recipes/top25random | Search for recipes. There are many parameters that you can apply. Starting with the most common, use title_kw to search within a title. |
| GET | /recipes | Search for recipes. There are many parameters that you can apply. Starting with the most common, use title_kw to search within a title. |
| GET | /recipes/recentviews | Get a list of recipes that the authenticated user has most recently viewed |
## Common Questions
Match user requests to endpoints in references/api-spec.lap. Key patterns:
- "Get collection details?" -> GET /collection/{id}
- "List all meta?" -> GET /collection/{id}/meta
- "List all collections?" -> GET /collections
- "Create a department?" -> POST /grocerylist/department
- "List all grocerylist?" -> GET /grocerylist
- "Create a recipe?" -> POST /grocerylist/recipe
- "Create a line?" -> POST /grocerylist/line
- "Create a item?" -> POST /grocerylist/item
- "Create a sync?" -> POST /grocerylist/sync
- "Update a item?" -> PUT /grocerylist/item/{guid}
- "Delete a item?" -> DELETE /grocerylist/item/{guid}
- "Create a clearcheckedline?" -> POST /grocerylist/clearcheckedlines
- "List all images?" -> GET /recipe/{recipeId}/images
- "List all pending?" -> GET /recipe/photos/pending
- "List all photos?" -> GET /recipe/{recipeId}/photos
- "List all scans?" -> GET /recipe/{recipeId}/scans
- "Create a image?" -> POST /recipe/{recipeId}/image
- "Create a avatar?" -> POST /image/avatar
- "List all me?" -> GET /me
- "List all skinny?" -> GET /me/skinny
- "List all options?" -> GET /me/preferences/options
- "Get note details?" -> GET /recipe/{recipeId}/note/{noteId}
- "Update a note?" -> PUT /recipe/{recipeId}/note/{noteId}
- "Delete a note?" -> DELETE /recipe/{recipeId}/note/{noteId}
- "List all notes?" -> GET /recipe/{recipeId}/notes
- "Create a note?" -> POST /recipe/{recipeId}/note
- "List all raves?" -> GET /recipes/raves
- "List all zap?" -> GET /recipe/{id}/zap
- "Get recipe details?" -> GET /recipe/{id}
- "Delete a recipe?" -> DELETE /recipe/{id}
- "Get recipe details?" -> GET /recipes/{id}
- "Get step details?" -> GET /recipe/steps/{id}
- "Create a step?" -> POST /recipe/post/step
- "Create a number?" -> POST /recipe/get/step/number
- "List all recipe?" -> GET /recipe/get/active/recipe
- "Create a step?" -> POST /recipe/get/saved/step
- "List all related?" -> GET /recipe/{recipeId}/related
- "Create a feedback?" -> POST /recipe/{recipeId}/feedback
- "List all random?" -> GET /recipes/random
- "List all top25random?" -> GET /recipes/top25random
- "List all recipes?" -> GET /recipes
- "List all categories?" -> GET /recipe/categories
- "Search autocomplete?" -> GET /recipe/autocomplete
- "Search mine?" -> GET /recipe/autocomplete/mine
- "Search all?" -> GET /recipe/autocomplete/all
- "Create a scan?" -> POST /recipe/scan
- "Create a recipe?" -> POST /recipe
- "List all recentviews?" -> GET /recipes/recentviews
- "Get review details?" -> GET /recipe/{recipeId}/review/{reviewId}
- "Update a review?" -> PUT /recipe/{recipeId}/review/{reviewId}
- "Delete a review?" -> DELETE /recipe/{recipeId}/review/{reviewId}
- "Get review details?" -> GET /recipe/review/{reviewId}
- "Update a review?" -> PUT /recipe/review/{reviewId}
- "List all review?" -> GET /recipe/{recipeId}/review
- "Create a review?" -> POST /recipe/{recipeId}/review
- "List all reviews?" -> GET /recipe/{recipeId}/reviews
- "List all replies?" -> GET /recipe/review/{reviewId}/replies
- "Create a reply?" -> POST /recipe/review/{reviewId}/replies
- "Update a reply?" -> PUT /recipe/review/replies/{replyId}
- "Delete a reply?" -> DELETE /recipe/review/replies/{replyId}
- "How to authenticate?" -> See Auth section
## Response Tips
- Check response schemas in references/api-spec.lap for field details
- List endpoints may support pagination; check for limit, offset, or cursor params
- Create/update endpoints typically return the created/updated object
## CLI
```bash
# Update this spec to the latest version
npx @lap-platform/lapsh get 1000000-recipe-and-grocery-list-api-v2 -o references/api-spec.lap
# Search for related APIs
npx @lap-platform/lapsh search 1000000-recipe-and-grocery-list-api-v2
```
## References
- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas
> Generated from the official API spec by [LAP](https://lap.sh)
LAP CLI -- compile, search, and manage API specs for AI agents. Use when working with API specifications (OpenAPI, GraphQL, AsyncAPI, Protobuf, Postman), com...
---
name: lap
description: "LAP CLI -- compile, search, and manage API specs for AI agents. Use when working with API specifications (OpenAPI, GraphQL, AsyncAPI, Protobuf, Postman), compiling specs to LAP format, searching the LAP registry, generating skills from API specs, or publishing APIs. Commands: compile, search, get, skill, skill-install, skill-batch, publish, login, logout, whoami."
user-invocable: true
version: 1.0.0
metadata:
openclaw:
emoji: "\u26A1"
requires:
anyBins: ["npx", "lapsh"]
install:
- id: node
kind: node
package: "@lap-platform/lapsh"
bins: ["lapsh"]
label: "Install LAP CLI (npm)"
---
# LAP CLI
Compile, search, and manage API specs for AI agents.
## Command Resolution
Detect the available CLI binary once per session:
```bash
# Prefer global install, fall back to npx
if command -v lapsh &>/dev/null; then
LAP_CMD="lapsh"
else
LAP_CMD="npx @lap-platform/lapsh"
fi
```
Use `$LAP_CMD` (or the resolved form) for all commands below.
---
## Agent Flow -- Consuming APIs
Use this flow when a user needs to find, download, or work with an API.
### 1. Discover
```bash
lapsh search <query> [--tag <tag>] [--sort relevance|popularity|date] [--limit <n>]
```
Search the LAP registry. Results show name, endpoint count, compression ratio, and a `[skill]` marker for installable skills.
```bash
# Find payment APIs sorted by popularity
lapsh search payment --sort popularity
# JSON output for scripting
lapsh search payment --json | jq '.results[] | select(.has_skill) | .name'
```
### 2. Acquire
**Option A -- Install a skill** (if `[skill]` marker present):
```bash
lapsh skill-install <name>
# Installs to ~/.claude/skills/<name>/
```
**Option B -- Download the spec**:
```bash
lapsh get <name> -o <name>.lap
lapsh get <name> --lean -o <name>.lean.lap
```
**Option C -- Compile a local spec**:
```bash
lapsh compile <spec-file> -o output.lap
lapsh compile <spec-file> -o output.lean.lap --lean
```
Supported formats: OpenAPI (YAML/JSON), GraphQL (SDL), AsyncAPI, Protobuf, Postman, Smithy. Format is auto-detected.
### 3. Use
Once you have a `.lap` file, read it directly -- LAP is designed for AI consumption. Key markers:
| Marker | Meaning |
|--------|---------|
| `@api` | API name, version, base URL |
| `@endpoint` | HTTP method + path |
| `@param` | Parameter (query, path, header) |
| `@body` | Request body schema |
| `@response` | Response status + schema |
| `@required` | Required fields |
| `@error` | Error response |
---
## Publisher Flow -- Publishing APIs
Use this flow when a user wants to compile, package, and publish an API spec.
### 1. Authenticate
```bash
lapsh login
lapsh whoami # verify
```
### 2. Compile
```bash
lapsh compile spec.yaml -o spec.lap
lapsh compile spec.yaml -o spec.lean.lap --lean
```
### 3. Generate Skill
```bash
# Basic skill (Layer 1 -- mechanical)
lapsh skill spec.yaml -o skills/ --no-ai
# AI-enhanced skill (Layer 2 -- requires claude CLI)
lapsh skill spec.yaml -o skills/ --ai
# Generate and install directly
lapsh skill spec.yaml --install
```
### 4. Publish
```bash
lapsh publish spec.yaml --provider stripe.com
lapsh publish spec.yaml --provider stripe.com --name charges --source-url https://...
lapsh publish spec.yaml --provider stripe.com --skill # include skill
lapsh publish spec.yaml --provider stripe.com --skill --skill-ai # with AI skill
```
### 5. Verify
```bash
lapsh search <name> # confirm it appears in registry
```
### 6. Batch Operations
```bash
# Generate skills for all specs in a directory
lapsh skill-batch specs/ -o skills/
```
---
## Quick Reference
### Core Commands
| Command | Description |
|---------|-------------|
| `compile <spec>` | Compile API spec to LAP format |
### Registry Commands
| Command | Description |
|---------|-------------|
| `search <query>` | Search the LAP registry |
| `get <name>` | Download a LAP spec |
| `publish <spec>` | Compile and publish to registry |
| `login` | Authenticate via GitHub OAuth |
| `logout` | Revoke token |
| `whoami` | Show authenticated user |
### Skill Commands
| Command | Description |
|---------|-------------|
| `skill <spec>` | Generate Claude Code skill from spec |
| `skill-batch <dir>` | Batch generate skills |
| `skill-install <name>` | Install skill from registry |
---
## Error Recovery
| Problem | Fix |
|---------|-----|
| `command not found: lapsh` | `npm install -g @lap-platform/lapsh` or use `npx @lap-platform/lapsh` |
| `Not authenticated` | Run `lapsh login` first |
| `Format detection failed` | Pass `-f openapi` (or graphql, asyncapi, protobuf, postman, smithy) |
| `403 Forbidden` on get | Spec may be private or registry may block without User-Agent -- update lapsh |
| `YAML parse error` | Check spec is valid YAML/JSON -- use a linter first |
| `Layer 2 requires claude` | Install Claude CLI or use `--no-ai` for Layer 1 skills |
| `Provider required` | `publish` needs `--provider <domain>` (e.g., `--provider stripe.com`) |
---
## Environment Variables
| Variable | Purpose | Default |
|----------|---------|---------|
| `LAP_REGISTRY` | Override registry URL | `https://registry.lap.sh` |
---
## References
- [{baseDir}/references/agent-flow.md](references/agent-flow.md) -- Extended agent workflow with examples
- [{baseDir}/references/publisher-flow.md](references/publisher-flow.md) -- Extended publisher workflow with examples
- [{baseDir}/references/command-reference.md](references/command-reference.md) -- Complete command reference with all flags
FILE:references/agent-flow.md
# Agent Flow -- Discovering and Using APIs
This reference covers the full workflow for AI agents consuming APIs through LAP.
---
## Step 1: Discover APIs
### Basic Search
```bash
lapsh search payment
lapsh search "email sending"
lapsh search stripe
```
### Filtered Search
```bash
# By tag
lapsh search api --tag fintech
lapsh search api --tag ai
# By popularity
lapsh search payment --sort popularity
# Paginated
lapsh search api --limit 10 --offset 20
```
### JSON Output for Scripting
```bash
# All results as JSON
lapsh search payment --json
# Extract names with skills
lapsh search payment --json | jq '.results[] | select(.has_skill) | .name'
# Get endpoint counts
lapsh search payment --json | jq '.results[] | {name, endpoints}'
# Find large APIs (50+ endpoints)
lapsh search api --json | jq '.results[] | select(.endpoints > 50) | .name'
```
### Reading Search Results
Human-readable output columns:
- **Name** -- API identifier (use with `get` and `skill-install`)
- **Endpoints** -- Number of endpoints in the spec
- **Ratio** -- Compression ratio vs. original spec
- **Description** -- Short summary
- **[skill]** -- Marker indicating a pre-built skill is available
---
## Step 2: Acquire the API
### Option A: Install a Pre-built Skill
Best when: the search result has a `[skill]` marker and you want to use the API immediately.
```bash
lapsh skill-install stripe
# Installs to ~/.claude/skills/stripe/
```
The installed skill contains:
- `SKILL.md` -- Metadata and usage instructions
- `references/` -- LAP spec and additional context
Custom install location:
```bash
lapsh skill-install stripe --dir ./project-skills/stripe
```
### Option B: Download the Spec
Best when: you need the raw LAP spec for custom processing or the API has no skill.
```bash
# Standard (includes descriptions)
lapsh get stripe -o stripe.lap
# Lean (maximum compression)
lapsh get stripe --lean -o stripe.lean.lap
```
**Standard vs. Lean:**
- **Standard**: Preserves descriptions, examples, and documentation. Better for understanding what an API does.
- **Lean**: Strips descriptions, keeps only structural information. 2-3x smaller than standard. Better when context window is tight.
### Option C: Compile a Local Spec
Best when: you have the original API spec file locally.
```bash
# Auto-detect format
lapsh compile petstore.yaml -o petstore.lap
# Lean mode
lapsh compile petstore.yaml -o petstore.lean.lap --lean
# Force format detection
lapsh compile spec.json -f openapi -o spec.lap
# Compile GraphQL schema
lapsh compile schema.graphql -o schema.lap
# Compile Postman collection
lapsh compile collection.json -f postman -o collection.lap
```
Supported source formats:
- OpenAPI 3.x (YAML or JSON)
- GraphQL SDL
- AsyncAPI
- Protobuf
- Postman Collection v2.x
- Smithy
---
## Step 3: Read the LAP Spec
LAP is a line-oriented, token-efficient format designed for AI consumption. You can read `.lap` files directly.
### Key Markers
| Marker | Purpose | Example |
|--------|---------|---------|
| `@api` | API name, version, base URL | `@api Stripe Charges v1 https://api.stripe.com` |
| `@toc` | Table of contents | `@toc GET /v1/charges -- List charges` |
| `@endpoint` | Endpoint definition | `@endpoint GET /v1/charges` |
| `@desc` | Description (standard mode only) | `@desc List all charges` |
| `@param` | Parameter | `@param query limit integer -- Max results` |
| `@body` | Request body | `@body application/json` |
| `@response` | Response definition | `@response 200 application/json` |
| `@required` | Required fields | `@required amount currency` |
| `@error` | Error response | `@error 401 -- Unauthorized` |
| `@field` | Object field | `@field id string -- Unique identifier` |
| `@auth` | Authentication | `@auth bearer` |
### Reading Strategy
1. Start with `@api` to understand the API identity and base URL
2. Scan `@toc` for a quick overview of all endpoints
3. Jump to specific `@endpoint` blocks as needed
4. Look at `@required` to understand mandatory fields
5. Check `@error` blocks for failure modes
---
## End-to-End Example
**Scenario**: "I need to integrate a payment API"
```bash
# 1. Search for payment APIs
lapsh search payment --sort popularity
# Output shows:
# stripe 120 endpoints 5.8x Stripe payment processing [skill]
# square 85 endpoints 4.2x Square payments API [skill]
# ...
# 2. Install the Stripe skill (has [skill] marker)
lapsh skill-install stripe
# 3. The skill is now at ~/.claude/skills/stripe/
# Claude Code auto-discovers it for Stripe API tasks
# Alternative: get the raw spec for custom use
lapsh get stripe -o stripe.lap
# Or compile a local spec you already have
lapsh compile my-openapi.yaml -o my-api.lap --lean
```
**Scenario**: "Find me an AI/ML API with a skill"
```bash
# Search with tag filter
lapsh search ai --tag ai --json | jq '.results[] | select(.has_skill) | {name, endpoints, description}'
# Install the one you want
lapsh skill-install openai
```
---
## Tips
- Always check for `[skill]` in search results before manually compiling -- pre-built skills save time
- Use `--lean` when context window is tight; use standard when you need to understand the API
- Pipe `--json` output through `jq` for programmatic discovery
- LAP specs are plain text -- you can grep, diff, and version-control them
- The `@toc` section gives you a quick overview without reading the entire spec
FILE:references/command-reference.md
# LAP CLI -- Command Reference
Complete reference for all LAP CLI commands and flags.
All commands are available via `npx @lap-platform/lapsh` or a global `lapsh` install.
---
## Core Commands
### compile
Compile any API spec to LAP format. Auto-detects input format.
```
lapsh compile <spec> [OPTIONS]
```
| Flag | Type | Description |
|------|------|-------------|
| `-o, --output <path>` | string | Output file path (default: stdout) |
| `-f, --format <fmt>` | string | Force input format: `openapi`, `graphql`, `asyncapi`, `protobuf`, `postman`, `smithy` |
| `--lean` | boolean | Maximum compression -- strips descriptions |
**Examples:**
```bash
# Auto-detect format, write to file
lapsh compile petstore.yaml -o petstore.lap
# Lean mode
lapsh compile petstore.yaml -o petstore.lean.lap --lean
# Force format
lapsh compile spec.json -f openapi -o spec.lap
```
---
## Registry Commands
### search
Search the LAP registry for APIs. No authentication required.
```
lapsh search <query> [OPTIONS]
```
| Flag | Type | Description |
|------|------|-------------|
| `--tag <tag>` | string | Filter by tag |
| `--sort <field>` | string | Sort by: `relevance`, `popularity`, `date` |
| `--limit <n>` | number | Maximum results (default: 50) |
| `--offset <n>` | number | Pagination offset |
| `--json` | boolean | Output raw JSON |
**Examples:**
```bash
lapsh search payment
lapsh search stripe --sort popularity
lapsh search api --tag fintech --limit 10
lapsh search payment --json | jq '.results[].name'
```
---
### get
Download a LAP spec from the registry.
```
lapsh get <name> [OPTIONS]
```
| Flag | Type | Description |
|------|------|-------------|
| `-o, --output <path>` | string | Output file path (default: stdout) |
| `--lean` | boolean | Download lean variant |
**Examples:**
```bash
lapsh get stripe -o stripe.lap
lapsh get stripe --lean -o stripe.lean.lap
```
---
### publish
Compile and publish a spec to the LAP registry. Requires authentication.
```
lapsh publish <spec> --provider <slug> [OPTIONS]
```
| Flag | Type | Description |
|------|------|-------------|
| `--provider <slug>` | string | **Required.** Provider domain or slug (e.g., `stripe.com`) |
| `--name <name>` | string | Override spec name (auto-detected from `@api` if omitted) |
| `--source-url <url>` | string | Upstream spec URL |
| `--skill` | boolean | Generate and include Claude Code skill |
| `--skill-ai` | boolean | Force AI enhancement for included skill |
| `--no-skill-ai` | boolean | Skip AI enhancement for included skill |
**Examples:**
```bash
lapsh publish petstore.yaml --provider petstore.io
lapsh publish stripe.yaml --provider stripe.com --skill --skill-ai
lapsh publish api.yaml --provider example.com --name my-api --source-url https://example.com/spec.yaml
```
---
### login
Authenticate with the LAP registry via GitHub OAuth.
```
lapsh login [OPTIONS]
```
| Flag | Type | Description |
|------|------|-------------|
| `--name <token-name>` | string | Name for the API token (e.g., `ci-github-actions`) |
---
### logout
Log out and revoke the API token.
```
lapsh logout
```
No flags.
---
### whoami
Show the currently authenticated user.
```
lapsh whoami
```
No flags.
---
## Skill Commands
### skill
Generate a Claude Code skill from an API spec.
```
lapsh skill <spec> [OPTIONS]
```
| Flag | Type | Description |
|------|------|-------------|
| `-o, --output <dir>` | string | Output parent directory (default: same directory as spec) |
| `-f, --format <fmt>` | string | Force spec format |
| `--ai` | boolean | Force AI enhancement (requires `claude` CLI) |
| `--no-ai` | boolean | Skip AI enhancement |
| `--full-spec` | boolean | Include full spec instead of lean |
| `--install` | boolean | Install skill directly to `~/.claude/skills/` |
| `--version <ver>` | string | Skill version (default: `1.0.0`) |
**Layer behavior:**
- If `claude` CLI is installed, defaults to AI-enhanced (Layer 2)
- Without `claude` CLI, defaults to mechanical (Layer 1)
- Use `--ai` / `--no-ai` to override
**Examples:**
```bash
# Basic skill
lapsh skill petstore.yaml -o skills/
# AI-enhanced skill
lapsh skill petstore.yaml -o skills/ --ai
# Generate and install
lapsh skill petstore.yaml --install
```
---
### skill-batch
Batch generate skills for all specs in a directory.
```
lapsh skill-batch <dir> -o <outdir> [OPTIONS]
```
| Flag | Type | Description |
|------|------|-------------|
| `-o, --output <dir>` | string | **Required.** Output directory for all skills |
| `--ai` | boolean | Force AI enhancement |
| `--no-ai` | boolean | Skip AI enhancement |
| `-v, --verbose` | boolean | Print full tracebacks on failure |
**Examples:**
```bash
lapsh skill-batch specs/ -o skills/
lapsh skill-batch specs/ -o skills/ --ai --verbose
```
---
### skill-install
Install a skill from the LAP registry.
```
lapsh skill-install <name> [OPTIONS]
```
| Flag | Type | Description |
|------|------|-------------|
| `--dir <path>` | string | Custom install directory (default: `~/.claude/skills/<name>`) |
**Examples:**
```bash
lapsh skill-install stripe
lapsh skill-install stripe --dir ./my-skills/stripe
```
---
## Environment Variables
| Variable | Purpose | Default |
|----------|---------|---------|
| `LAP_REGISTRY` | Override registry URL | `https://registry.lap.sh` |
---
## Notes
- **Format auto-detection**: Works for OpenAPI (YAML/JSON), GraphQL (SDL), AsyncAPI, Protobuf, Postman collections, and Smithy
- **Lean mode**: Strips descriptions and non-essential metadata for maximum compression. Use for agent consumption where context window is tight
- **Standard mode**: Preserves descriptions and documentation. Use when human readability matters
- **Credentials**: Stored locally after `lapsh login`. Token is revoked on `lapsh logout`
- **User-Agent**: The CLI sends `lapsh/<version>` as User-Agent for registry requests
FILE:references/publisher-flow.md
# Publisher Flow -- Compiling and Publishing APIs
This reference covers the full workflow for publishing API specs to the LAP registry.
---
## Step 1: Authenticate
### Login
```bash
lapsh login
```
Opens a browser for GitHub OAuth. After authorizing, the token is stored locally.
Name your token for identification (useful for CI):
```bash
lapsh login --name ci-github-actions
```
### Verify
```bash
lapsh whoami
# Output: logged in as <username>
```
### Logout
```bash
lapsh logout
# Revokes the token
```
---
## Step 2: Compile Your Spec
### Basic Compilation
```bash
lapsh compile api.yaml -o api.lap
```
### Lean Mode
Strips descriptions and non-essential metadata for maximum compression:
```bash
lapsh compile api.yaml -o api.lean.lap --lean
```
### Format Override
If auto-detection fails or you want to be explicit:
```bash
lapsh compile spec.json -f openapi -o spec.lap
lapsh compile schema.graphql -f graphql -o schema.lap
lapsh compile collection.json -f postman -o collection.lap
```
### Supported Source Formats
| Format | Extensions | Notes |
|--------|-----------|-------|
| OpenAPI 3.x | `.yaml`, `.yml`, `.json` | Most common |
| GraphQL | `.graphql`, `.gql` | SDL format |
| AsyncAPI | `.yaml`, `.yml`, `.json` | Event-driven APIs |
| Protobuf | `.proto` | gRPC services |
| Postman | `.json` | Collection v2.x |
| Smithy | `.smithy` | AWS-style models |
### Validate Output
Read the compiled LAP file to verify:
```bash
# Check it starts with @api and has expected endpoints
head -20 api.lap
```
---
## Step 3: Generate a Skill
Skills make APIs immediately usable in Claude Code and OpenClaw.
### Layer 1 -- Mechanical
Generates a skill from the spec structure alone. Fast, no external dependencies.
```bash
lapsh skill api.yaml -o skills/ --no-ai
```
### Layer 2 -- AI-Enhanced
Uses Claude CLI to generate richer descriptions, better examples, and smarter organization. Requires `claude` CLI installed.
```bash
lapsh skill api.yaml -o skills/ --ai
```
**Auto-detection**: If `claude` CLI is on PATH, Layer 2 is used automatically. Use `--no-ai` to force Layer 1.
### Skill Options
```bash
# Include full spec instead of lean (larger but more descriptive)
lapsh skill api.yaml -o skills/ --full-spec
# Set skill version
lapsh skill api.yaml -o skills/ --version 2.0.0
# Install directly to Claude Code skills directory
lapsh skill api.yaml --install
```
### Skill Output Structure
```
skills/<api-name>/
SKILL.md # Skill metadata and usage
references/
<name>.lap # Compiled spec (lean by default)
```
---
## Step 4: Publish
### Basic Publish
```bash
lapsh publish api.yaml --provider example.com
```
The `--provider` flag is required. Use the provider's domain (e.g., `stripe.com`, `twilio.com`).
### With Metadata
```bash
lapsh publish api.yaml \
--provider stripe.com \
--name charges \
--source-url https://raw.githubusercontent.com/stripe/openapi/master/spec3.yaml
```
- `--name` overrides the API name (auto-detected from `@api` if omitted)
- `--source-url` links to the upstream spec for reference
### With Skill
```bash
# Include a mechanical skill
lapsh publish api.yaml --provider example.com --skill
# Include an AI-enhanced skill
lapsh publish api.yaml --provider example.com --skill --skill-ai
# Include skill without AI enhancement
lapsh publish api.yaml --provider example.com --skill --no-skill-ai
```
---
## Step 5: Verify
### Search for Your Published Spec
```bash
lapsh search <name>
```
### Download and Verify
```bash
lapsh get <name> -o verify.lap
diff api.lap verify.lap
```
---
## Step 6: Batch Operations
### Batch Skill Generation
Generate skills for all specs in a directory:
```bash
lapsh skill-batch specs/ -o skills/
lapsh skill-batch specs/ -o skills/ --ai
lapsh skill-batch specs/ -o skills/ --verbose # show errors
```
Processes all `.yaml`, `.yml`, and `.json` files in the directory.
---
## End-to-End Example
**Scenario**: Publish a new API with a skill
```bash
# 1. Authenticate
lapsh login
lapsh whoami
# 2. Compile to verify
lapsh compile api.yaml -o api.lap
lapsh compile api.yaml -o api.lean.lap --lean
# 3. Generate and review skill locally
lapsh skill api.yaml -o ./skills/ --ai
# 4. Publish with skill
lapsh publish api.yaml --provider mycompany.com --skill --skill-ai
# 5. Verify it's live
lapsh search mycompany
# 6. Test the full loop -- install your own skill
lapsh skill-install mycompany
```
**Scenario**: Batch publish multiple APIs
```bash
# 1. Authenticate
lapsh login
# 2. Generate all skills
lapsh skill-batch specs/ -o skills/ --ai --verbose
# 3. Publish each spec
for f in specs/*.yaml; do
name=$(basename "$f" .yaml)
lapsh publish "$f" --provider mycompany.com --name "$name" --skill
done
```
**Scenario**: Update a published API
```bash
# 1. Compile new version
lapsh compile api-v2.yaml -o api-v2.lap
# 2. Regenerate skill
lapsh skill api-v2.yaml --install
# 3. Re-publish (overwrites previous version)
lapsh publish api-v2.yaml --provider mycompany.com --skill --skill-ai
```
---
## Tips
- Always `lapsh whoami` before publishing to confirm you're authenticated
- Use `--source-url` to link back to the canonical spec -- helps consumers find updates
- Generate skills with `--ai` for better quality if `claude` CLI is available
- Lean specs are typically 2-3x smaller than standard -- use lean for agent consumption
- Published specs are immutable per version -- publish a new version to update
Stripe API skill. Use when working with Stripe for account, account_links, account_sessions. Covers 587 endpoints.
---
name: lap-stripe-api
description: "Stripe API skill. Use when working with Stripe for account, account_links, account_sessions. Covers 587 endpoints."
version: 1.0.0
generator: lapsh
metadata:
openclaw:
requires:
env:
- STRIPE_API_API_KEY
---
# Stripe API
API version: 2026-02-25.clover
## Auth
Bearer basic | Bearer bearer
## Base URL
https://api.stripe.com/
## Setup
1. Set Authorization header with your Bearer token
2. GET /v1/account -- verify access
3. POST /v1/account_links -- create first account_links
## Endpoints
587 endpoints across 76 groups. See references/api-spec.lap for full details.
### account
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/account | Retrieve account |
### account_links
| Method | Path | Description |
|--------|------|-------------|
| POST | /v1/account_links | Create an account link |
### account_sessions
| Method | Path | Description |
|--------|------|-------------|
| POST | /v1/account_sessions | Create an Account Session |
### accounts
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/accounts | List all connected accounts |
| POST | /v1/accounts | <p>With <a href="/docs/connect">Connect</a>, you can create Stripe accounts for your users. |
| DELETE | /v1/accounts/{account} | Delete an account |
| GET | /v1/accounts/{account} | Retrieve account |
| POST | /v1/accounts/{account} | Update an account |
| POST | /v1/accounts/{account}/bank_accounts | Create an external account |
| DELETE | /v1/accounts/{account}/bank_accounts/{id} | Delete an external account |
| GET | /v1/accounts/{account}/bank_accounts/{id} | Retrieve an external account |
| POST | /v1/accounts/{account}/bank_accounts/{id} | <p>Updates the metadata, account holder name, account holder type of a bank account belonging to |
| GET | /v1/accounts/{account}/capabilities | List all account capabilities |
| GET | /v1/accounts/{account}/capabilities/{capability} | Retrieve an Account Capability |
| POST | /v1/accounts/{account}/capabilities/{capability} | Update an Account Capability |
| GET | /v1/accounts/{account}/external_accounts | List all external accounts |
| POST | /v1/accounts/{account}/external_accounts | Create an external account |
| DELETE | /v1/accounts/{account}/external_accounts/{id} | Delete an external account |
| GET | /v1/accounts/{account}/external_accounts/{id} | Retrieve an external account |
| POST | /v1/accounts/{account}/external_accounts/{id} | <p>Updates the metadata, account holder name, account holder type of a bank account belonging to |
| POST | /v1/accounts/{account}/login_links | Create a login link |
| GET | /v1/accounts/{account}/people | List all persons |
| POST | /v1/accounts/{account}/people | Create a person |
| DELETE | /v1/accounts/{account}/people/{person} | Delete a person |
| GET | /v1/accounts/{account}/people/{person} | Retrieve a person |
| POST | /v1/accounts/{account}/people/{person} | Update a person |
| GET | /v1/accounts/{account}/persons | List all persons |
| POST | /v1/accounts/{account}/persons | Create a person |
| DELETE | /v1/accounts/{account}/persons/{person} | Delete a person |
| GET | /v1/accounts/{account}/persons/{person} | Retrieve a person |
| POST | /v1/accounts/{account}/persons/{person} | Update a person |
| POST | /v1/accounts/{account}/reject | Reject an account |
### apple_pay
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/apple_pay/domains | <p>List apple pay domains.</p> |
| POST | /v1/apple_pay/domains | <p>Create an apple pay domain.</p> |
| DELETE | /v1/apple_pay/domains/{domain} | <p>Delete an apple pay domain.</p> |
| GET | /v1/apple_pay/domains/{domain} | <p>Retrieve an apple pay domain.</p> |
### application_fees
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/application_fees | List all application fees |
| GET | /v1/application_fees/{fee}/refunds/{id} | Retrieve an application fee refund |
| POST | /v1/application_fees/{fee}/refunds/{id} | Update an application fee refund |
| GET | /v1/application_fees/{id} | Retrieve an application fee |
| POST | /v1/application_fees/{id}/refund | |
| GET | /v1/application_fees/{id}/refunds | List all application fee refunds |
| POST | /v1/application_fees/{id}/refunds | Create an application fee refund |
### apps
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/apps/secrets | List secrets |
| POST | /v1/apps/secrets | Set a Secret |
| POST | /v1/apps/secrets/delete | Delete a Secret |
| GET | /v1/apps/secrets/find | Find a Secret |
### balance
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/balance | Retrieve balance |
| GET | /v1/balance/history | List all balance transactions |
| GET | /v1/balance/history/{id} | Retrieve a balance transaction |
### balance_settings
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/balance_settings | Retrieve balance settings |
| POST | /v1/balance_settings | Update balance settings |
### balance_transactions
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/balance_transactions | List all balance transactions |
| GET | /v1/balance_transactions/{id} | Retrieve a balance transaction |
### billing
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/billing/alerts | List billing alerts |
| POST | /v1/billing/alerts | Create a billing alert |
| GET | /v1/billing/alerts/{id} | Retrieve a billing alert |
| POST | /v1/billing/alerts/{id}/activate | Activate a billing alert |
| POST | /v1/billing/alerts/{id}/archive | Archive a billing alert |
| POST | /v1/billing/alerts/{id}/deactivate | Deactivate a billing alert |
| GET | /v1/billing/credit_balance_summary | Retrieve the credit balance summary for a customer |
| GET | /v1/billing/credit_balance_transactions | List credit balance transactions |
| GET | /v1/billing/credit_balance_transactions/{id} | Retrieve a credit balance transaction |
| GET | /v1/billing/credit_grants | List credit grants |
| POST | /v1/billing/credit_grants | Create a credit grant |
| GET | /v1/billing/credit_grants/{id} | Retrieve a credit grant |
| POST | /v1/billing/credit_grants/{id} | Update a credit grant |
| POST | /v1/billing/credit_grants/{id}/expire | Expire a credit grant |
| POST | /v1/billing/credit_grants/{id}/void | Void a credit grant |
| POST | /v1/billing/meter_event_adjustments | Create a billing meter event adjustment |
| POST | /v1/billing/meter_events | Create a billing meter event |
| GET | /v1/billing/meters | List billing meters |
| POST | /v1/billing/meters | Create a billing meter |
| GET | /v1/billing/meters/{id} | Retrieve a billing meter |
| POST | /v1/billing/meters/{id} | Update a billing meter |
| POST | /v1/billing/meters/{id}/deactivate | Deactivate a billing meter |
| GET | /v1/billing/meters/{id}/event_summaries | List billing meter event summaries |
| POST | /v1/billing/meters/{id}/reactivate | Reactivate a billing meter |
### billing_portal
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/billing_portal/configurations | List portal configurations |
| POST | /v1/billing_portal/configurations | Create a portal configuration |
| GET | /v1/billing_portal/configurations/{configuration} | Retrieve a portal configuration |
| POST | /v1/billing_portal/configurations/{configuration} | Update a portal configuration |
| POST | /v1/billing_portal/sessions | Create a portal session |
### charges
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/charges | List all charges |
| POST | /v1/charges | <p>This method is no longer recommended—use the <a href="/docs/api/payment_intents">Payment Intents API</a> |
| GET | /v1/charges/search | Search charges |
| GET | /v1/charges/{charge} | Retrieve a charge |
| POST | /v1/charges/{charge} | Update a charge |
| POST | /v1/charges/{charge}/capture | Capture a payment |
| GET | /v1/charges/{charge}/dispute | <p>Retrieve a dispute for a specified charge.</p> |
| POST | /v1/charges/{charge}/dispute | |
| POST | /v1/charges/{charge}/dispute/close | |
| POST | /v1/charges/{charge}/refund | Create a refund |
| GET | /v1/charges/{charge}/refunds | List all refunds |
| POST | /v1/charges/{charge}/refunds | Create customer balance refund |
| GET | /v1/charges/{charge}/refunds/{refund} | <p>Retrieves the details of an existing refund.</p> |
| POST | /v1/charges/{charge}/refunds/{refund} | <p>Update a specified refund.</p> |
### checkout
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/checkout/sessions | List all Checkout Sessions |
| POST | /v1/checkout/sessions | Create a Checkout Session |
| GET | /v1/checkout/sessions/{session} | Retrieve a Checkout Session |
| POST | /v1/checkout/sessions/{session} | Update a Checkout Session |
| POST | /v1/checkout/sessions/{session}/expire | Expire a Checkout Session |
| GET | /v1/checkout/sessions/{session}/line_items | Retrieve a Checkout Session's line items |
### climate
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/climate/orders | List orders |
| POST | /v1/climate/orders | Create an order |
| GET | /v1/climate/orders/{order} | Retrieve an order |
| POST | /v1/climate/orders/{order} | Update an order |
| POST | /v1/climate/orders/{order}/cancel | Cancel an order |
| GET | /v1/climate/products | List products |
| GET | /v1/climate/products/{product} | Retrieve a product |
| GET | /v1/climate/suppliers | List suppliers |
| GET | /v1/climate/suppliers/{supplier} | Retrieve a supplier |
### confirmation_tokens
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/confirmation_tokens/{confirmation_token} | Retrieve a ConfirmationToken |
### country_specs
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/country_specs | List Country Specs |
| GET | /v1/country_specs/{country} | Retrieve a Country Spec |
### coupons
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/coupons | List all coupons |
| POST | /v1/coupons | Create a coupon |
| DELETE | /v1/coupons/{coupon} | Delete a coupon |
| GET | /v1/coupons/{coupon} | Retrieve a coupon |
| POST | /v1/coupons/{coupon} | Update a coupon |
### credit_notes
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/credit_notes | List all credit notes |
| POST | /v1/credit_notes | Create a credit note |
| GET | /v1/credit_notes/preview | Preview a credit note |
| GET | /v1/credit_notes/preview/lines | Retrieve a credit note preview's line items |
| GET | /v1/credit_notes/{credit_note}/lines | Retrieve a credit note's line items |
| GET | /v1/credit_notes/{id} | Retrieve a credit note |
| POST | /v1/credit_notes/{id} | Update a credit note |
| POST | /v1/credit_notes/{id}/void | Void a credit note |
### customer_sessions
| Method | Path | Description |
|--------|------|-------------|
| POST | /v1/customer_sessions | Create a Customer Session |
### customers
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/customers | List all customers |
| POST | /v1/customers | Create a customer |
| GET | /v1/customers/search | Search customers |
| DELETE | /v1/customers/{customer} | Delete a customer |
| GET | /v1/customers/{customer} | Retrieve a customer |
| POST | /v1/customers/{customer} | Update a customer |
| GET | /v1/customers/{customer}/balance_transactions | List customer balance transactions |
| POST | /v1/customers/{customer}/balance_transactions | Create a customer balance transaction |
| GET | /v1/customers/{customer}/balance_transactions/{transaction} | Retrieve a customer balance transaction |
| POST | /v1/customers/{customer}/balance_transactions/{transaction} | Update a customer credit balance transaction |
| GET | /v1/customers/{customer}/bank_accounts | List all bank accounts |
| POST | /v1/customers/{customer}/bank_accounts | Create a card |
| DELETE | /v1/customers/{customer}/bank_accounts/{id} | Delete a customer source |
| GET | /v1/customers/{customer}/bank_accounts/{id} | Retrieve a bank account |
| POST | /v1/customers/{customer}/bank_accounts/{id} | <p>Update a specified source for a given customer.</p> |
| POST | /v1/customers/{customer}/bank_accounts/{id}/verify | Verify a bank account |
| GET | /v1/customers/{customer}/cards | List all cards |
| POST | /v1/customers/{customer}/cards | Create a card |
| DELETE | /v1/customers/{customer}/cards/{id} | Delete a customer source |
| GET | /v1/customers/{customer}/cards/{id} | Retrieve a card |
| POST | /v1/customers/{customer}/cards/{id} | <p>Update a specified source for a given customer.</p> |
| GET | /v1/customers/{customer}/cash_balance | Retrieve a cash balance |
| POST | /v1/customers/{customer}/cash_balance | Update a cash balance's settings |
| GET | /v1/customers/{customer}/cash_balance_transactions | List cash balance transactions |
| GET | /v1/customers/{customer}/cash_balance_transactions/{transaction} | Retrieve a cash balance transaction |
| DELETE | /v1/customers/{customer}/discount | Delete a customer discount |
| GET | /v1/customers/{customer}/discount | |
| POST | /v1/customers/{customer}/funding_instructions | Create or retrieve funding instructions for a customer cash balance |
| GET | /v1/customers/{customer}/payment_methods | List a Customer's PaymentMethods |
| GET | /v1/customers/{customer}/payment_methods/{payment_method} | Retrieve a Customer's PaymentMethod |
| GET | /v1/customers/{customer}/sources | <p>List sources for a specified customer.</p> |
| POST | /v1/customers/{customer}/sources | Create a card |
| DELETE | /v1/customers/{customer}/sources/{id} | Delete a customer source |
| GET | /v1/customers/{customer}/sources/{id} | <p>Retrieve a specified source for a given customer.</p> |
| POST | /v1/customers/{customer}/sources/{id} | <p>Update a specified source for a given customer.</p> |
| POST | /v1/customers/{customer}/sources/{id}/verify | Verify a bank account |
| GET | /v1/customers/{customer}/subscriptions | List active subscriptions |
| POST | /v1/customers/{customer}/subscriptions | Create a subscription |
| DELETE | /v1/customers/{customer}/subscriptions/{subscription_exposed_id} | Cancel a subscription |
| GET | /v1/customers/{customer}/subscriptions/{subscription_exposed_id} | Retrieve a subscription |
| POST | /v1/customers/{customer}/subscriptions/{subscription_exposed_id} | Update a subscription on a customer |
| DELETE | /v1/customers/{customer}/subscriptions/{subscription_exposed_id}/discount | Delete a customer discount |
| GET | /v1/customers/{customer}/subscriptions/{subscription_exposed_id}/discount | |
| GET | /v1/customers/{customer}/tax_ids | List all Customer tax IDs |
| POST | /v1/customers/{customer}/tax_ids | Create a Customer tax ID |
| DELETE | /v1/customers/{customer}/tax_ids/{id} | Delete a Customer tax ID |
| GET | /v1/customers/{customer}/tax_ids/{id} | Retrieve a Customer tax ID |
### disputes
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/disputes | List all disputes |
| GET | /v1/disputes/{dispute} | Retrieve a dispute |
| POST | /v1/disputes/{dispute} | Update a dispute |
| POST | /v1/disputes/{dispute}/close | Close a dispute |
### entitlements
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/entitlements/active_entitlements | List all active entitlements |
| GET | /v1/entitlements/active_entitlements/{id} | Retrieve an active entitlement |
| GET | /v1/entitlements/features | List all features |
| POST | /v1/entitlements/features | Create a feature |
| GET | /v1/entitlements/features/{id} | Retrieve a feature |
| POST | /v1/entitlements/features/{id} | Updates a feature |
### ephemeral_keys
| Method | Path | Description |
|--------|------|-------------|
| POST | /v1/ephemeral_keys | Create an ephemeral key |
| DELETE | /v1/ephemeral_keys/{key} | Immediately invalidate an ephemeral key |
### events
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/events | List all events |
| GET | /v1/events/{id} | Retrieve an event |
### exchange_rates
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/exchange_rates | List all exchange rates |
| GET | /v1/exchange_rates/{rate_id} | Retrieve an exchange rate |
### external_accounts
| Method | Path | Description |
|--------|------|-------------|
| POST | /v1/external_accounts/{id} | <p>Updates the metadata, account holder name, account holder type of a bank account belonging to |
### file_links
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/file_links | List all file links |
| POST | /v1/file_links | Create a file link |
| GET | /v1/file_links/{link} | Retrieve a file link |
| POST | /v1/file_links/{link} | Update a file link |
### files
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/files | List all files |
| POST | /v1/files | Create a file |
| GET | /v1/files/{file} | Retrieve a file |
### financial_connections
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/financial_connections/accounts | List Accounts |
| GET | /v1/financial_connections/accounts/{account} | Retrieve an Account |
| POST | /v1/financial_connections/accounts/{account}/disconnect | Disconnect an Account |
| GET | /v1/financial_connections/accounts/{account}/owners | List Account Owners |
| POST | /v1/financial_connections/accounts/{account}/refresh | Refresh Account data |
| POST | /v1/financial_connections/accounts/{account}/subscribe | Subscribe to data refreshes for an Account |
| POST | /v1/financial_connections/accounts/{account}/unsubscribe | Unsubscribe from data refreshes for an Account |
| POST | /v1/financial_connections/sessions | Create a Session |
| GET | /v1/financial_connections/sessions/{session} | Retrieve a Session |
| GET | /v1/financial_connections/transactions | List Transactions |
| GET | /v1/financial_connections/transactions/{transaction} | Retrieve a Transaction |
### forwarding
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/forwarding/requests | List all ForwardingRequests |
| POST | /v1/forwarding/requests | Create a ForwardingRequest |
| GET | /v1/forwarding/requests/{id} | Retrieve a ForwardingRequest |
### identity
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/identity/verification_reports | List VerificationReports |
| GET | /v1/identity/verification_reports/{report} | Retrieve a VerificationReport |
| GET | /v1/identity/verification_sessions | List VerificationSessions |
| POST | /v1/identity/verification_sessions | Create a VerificationSession |
| GET | /v1/identity/verification_sessions/{session} | Retrieve a VerificationSession |
| POST | /v1/identity/verification_sessions/{session} | Update a VerificationSession |
| POST | /v1/identity/verification_sessions/{session}/cancel | Cancel a VerificationSession |
| POST | /v1/identity/verification_sessions/{session}/redact | Redact a VerificationSession |
### invoice_payments
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/invoice_payments | List all payments for an invoice |
| GET | /v1/invoice_payments/{invoice_payment} | Retrieve an InvoicePayment |
### invoice_rendering_templates
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/invoice_rendering_templates | List all invoice rendering templates |
| GET | /v1/invoice_rendering_templates/{template} | Retrieve an invoice rendering template |
| POST | /v1/invoice_rendering_templates/{template}/archive | Archive an invoice rendering template |
| POST | /v1/invoice_rendering_templates/{template}/unarchive | Unarchive an invoice rendering template |
### invoiceitems
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/invoiceitems | List all invoice items |
| POST | /v1/invoiceitems | Create an invoice item |
| DELETE | /v1/invoiceitems/{invoiceitem} | Delete an invoice item |
| GET | /v1/invoiceitems/{invoiceitem} | Retrieve an invoice item |
| POST | /v1/invoiceitems/{invoiceitem} | Update an invoice item |
### invoices
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/invoices | List all invoices |
| POST | /v1/invoices | Create an invoice |
| POST | /v1/invoices/create_preview | Create a preview invoice |
| GET | /v1/invoices/search | Search invoices |
| DELETE | /v1/invoices/{invoice} | Delete a draft invoice |
| GET | /v1/invoices/{invoice} | Retrieve an invoice |
| POST | /v1/invoices/{invoice} | Update an invoice |
| POST | /v1/invoices/{invoice}/add_lines | Bulk add invoice line items |
| POST | /v1/invoices/{invoice}/attach_payment | Attach a payment to an Invoice |
| POST | /v1/invoices/{invoice}/finalize | Finalize an invoice |
| GET | /v1/invoices/{invoice}/lines | Retrieve an invoice's line items |
| POST | /v1/invoices/{invoice}/lines/{line_item_id} | Update an invoice's line item |
| POST | /v1/invoices/{invoice}/mark_uncollectible | Mark an invoice as uncollectible |
| POST | /v1/invoices/{invoice}/pay | Pay an invoice |
| POST | /v1/invoices/{invoice}/remove_lines | Bulk remove invoice line items |
| POST | /v1/invoices/{invoice}/send | Send an invoice for manual payment |
| POST | /v1/invoices/{invoice}/update_lines | Bulk update invoice line items |
| POST | /v1/invoices/{invoice}/void | Void an invoice |
### issuing
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/issuing/authorizations | List all authorizations |
| GET | /v1/issuing/authorizations/{authorization} | Retrieve an authorization |
| POST | /v1/issuing/authorizations/{authorization} | Update an authorization |
| POST | /v1/issuing/authorizations/{authorization}/approve | Approve an authorization |
| POST | /v1/issuing/authorizations/{authorization}/decline | Decline an authorization |
| GET | /v1/issuing/cardholders | List all cardholders |
| POST | /v1/issuing/cardholders | Create a cardholder |
| GET | /v1/issuing/cardholders/{cardholder} | Retrieve a cardholder |
| POST | /v1/issuing/cardholders/{cardholder} | Update a cardholder |
| GET | /v1/issuing/cards | List all cards |
| POST | /v1/issuing/cards | Create a card |
| GET | /v1/issuing/cards/{card} | Retrieve a card |
| POST | /v1/issuing/cards/{card} | Update a card |
| GET | /v1/issuing/disputes | List all disputes |
| POST | /v1/issuing/disputes | Create a dispute |
| GET | /v1/issuing/disputes/{dispute} | Retrieve a dispute |
| POST | /v1/issuing/disputes/{dispute} | Update a dispute |
| POST | /v1/issuing/disputes/{dispute}/submit | Submit a dispute |
| GET | /v1/issuing/personalization_designs | List all personalization designs |
| POST | /v1/issuing/personalization_designs | Create a personalization design |
| GET | /v1/issuing/personalization_designs/{personalization_design} | Retrieve a personalization design |
| POST | /v1/issuing/personalization_designs/{personalization_design} | Update a personalization design |
| GET | /v1/issuing/physical_bundles | List all physical bundles |
| GET | /v1/issuing/physical_bundles/{physical_bundle} | Retrieve a physical bundle |
| GET | /v1/issuing/settlements/{settlement} | Retrieve a settlement |
| POST | /v1/issuing/settlements/{settlement} | Update a settlement |
| GET | /v1/issuing/tokens | List all issuing tokens for card |
| GET | /v1/issuing/tokens/{token} | Retrieve an issuing token |
| POST | /v1/issuing/tokens/{token} | Update a token status |
| GET | /v1/issuing/transactions | List all transactions |
| GET | /v1/issuing/transactions/{transaction} | Retrieve a transaction |
| POST | /v1/issuing/transactions/{transaction} | Update a transaction |
### link_account_sessions
| Method | Path | Description |
|--------|------|-------------|
| POST | /v1/link_account_sessions | Create a Session |
| GET | /v1/link_account_sessions/{session} | Retrieve a Session |
### linked_accounts
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/linked_accounts | List Accounts |
| GET | /v1/linked_accounts/{account} | Retrieve an Account |
| POST | /v1/linked_accounts/{account}/disconnect | Disconnect an Account |
| GET | /v1/linked_accounts/{account}/owners | List Account Owners |
| POST | /v1/linked_accounts/{account}/refresh | Refresh Account data |
### mandates
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/mandates/{mandate} | Retrieve a Mandate |
### payment_attempt_records
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/payment_attempt_records | List Payment Attempt Records |
| GET | /v1/payment_attempt_records/{id} | Retrieve a Payment Attempt Record |
### payment_intents
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/payment_intents | List all PaymentIntents |
| POST | /v1/payment_intents | Create a PaymentIntent |
| GET | /v1/payment_intents/search | Search PaymentIntents |
| GET | /v1/payment_intents/{intent} | Retrieve a PaymentIntent |
| POST | /v1/payment_intents/{intent} | Update a PaymentIntent |
| GET | /v1/payment_intents/{intent}/amount_details_line_items | List all PaymentIntent LineItems |
| POST | /v1/payment_intents/{intent}/apply_customer_balance | Reconcile a customer_balance PaymentIntent |
| POST | /v1/payment_intents/{intent}/cancel | Cancel a PaymentIntent |
| POST | /v1/payment_intents/{intent}/capture | Capture a PaymentIntent |
| POST | /v1/payment_intents/{intent}/confirm | Confirm a PaymentIntent |
| POST | /v1/payment_intents/{intent}/increment_authorization | Increment an authorization |
| POST | /v1/payment_intents/{intent}/verify_microdeposits | Verify microdeposits on a PaymentIntent |
### payment_links
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/payment_links | List all payment links |
| POST | /v1/payment_links | Create a payment link |
| GET | /v1/payment_links/{payment_link} | Retrieve payment link |
| POST | /v1/payment_links/{payment_link} | Update a payment link |
| GET | /v1/payment_links/{payment_link}/line_items | Retrieve a payment link's line items |
### payment_method_configurations
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/payment_method_configurations | List payment method configurations |
| POST | /v1/payment_method_configurations | Create a payment method configuration |
| GET | /v1/payment_method_configurations/{configuration} | Retrieve payment method configuration |
| POST | /v1/payment_method_configurations/{configuration} | Update payment method configuration |
### payment_method_domains
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/payment_method_domains | List payment method domains |
| POST | /v1/payment_method_domains | Create a payment method domain |
| GET | /v1/payment_method_domains/{payment_method_domain} | Retrieve a payment method domain |
| POST | /v1/payment_method_domains/{payment_method_domain} | Update a payment method domain |
| POST | /v1/payment_method_domains/{payment_method_domain}/validate | Validate an existing payment method domain |
### payment_methods
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/payment_methods | List PaymentMethods |
| POST | /v1/payment_methods | Shares a PaymentMethod |
| GET | /v1/payment_methods/{payment_method} | Retrieve a PaymentMethod |
| POST | /v1/payment_methods/{payment_method} | Update a PaymentMethod |
| POST | /v1/payment_methods/{payment_method}/attach | Attach a PaymentMethod to a Customer |
| POST | /v1/payment_methods/{payment_method}/detach | Detach a PaymentMethod from a Customer |
### payment_records
| Method | Path | Description |
|--------|------|-------------|
| POST | /v1/payment_records/report_payment | Report a payment |
| GET | /v1/payment_records/{id} | Retrieve a Payment Record |
| POST | /v1/payment_records/{id}/report_payment_attempt | Report a payment attempt |
| POST | /v1/payment_records/{id}/report_payment_attempt_canceled | Report payment attempt canceled |
| POST | /v1/payment_records/{id}/report_payment_attempt_failed | Report payment attempt failed |
| POST | /v1/payment_records/{id}/report_payment_attempt_guaranteed | Report payment attempt guaranteed |
| POST | /v1/payment_records/{id}/report_payment_attempt_informational | Report payment attempt informational |
| POST | /v1/payment_records/{id}/report_refund | Report a refund |
### payouts
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/payouts | List all payouts |
| POST | /v1/payouts | Create a payout |
| GET | /v1/payouts/{payout} | Retrieve a payout |
| POST | /v1/payouts/{payout} | Update a payout |
| POST | /v1/payouts/{payout}/cancel | Cancel a payout |
| POST | /v1/payouts/{payout}/reverse | Reverse a payout |
### plans
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/plans | List all plans |
| POST | /v1/plans | Create a plan |
| DELETE | /v1/plans/{plan} | Delete a plan |
| GET | /v1/plans/{plan} | Retrieve a plan |
| POST | /v1/plans/{plan} | Update a plan |
### prices
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/prices | List all prices |
| POST | /v1/prices | Create a price |
| GET | /v1/prices/search | Search prices |
| GET | /v1/prices/{price} | Retrieve a price |
| POST | /v1/prices/{price} | Update a price |
### products
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/products | List all products |
| POST | /v1/products | Create a product |
| GET | /v1/products/search | Search products |
| DELETE | /v1/products/{id} | Delete a product |
| GET | /v1/products/{id} | Retrieve a product |
| POST | /v1/products/{id} | Update a product |
| GET | /v1/products/{product}/features | List all features attached to a product |
| POST | /v1/products/{product}/features | Attach a feature to a product |
| DELETE | /v1/products/{product}/features/{id} | Remove a feature from a product |
| GET | /v1/products/{product}/features/{id} | Retrieve a product_feature |
### promotion_codes
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/promotion_codes | List all promotion codes |
| POST | /v1/promotion_codes | Create a promotion code |
| GET | /v1/promotion_codes/{promotion_code} | Retrieve a promotion code |
| POST | /v1/promotion_codes/{promotion_code} | Update a promotion code |
### quotes
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/quotes | List all quotes |
| POST | /v1/quotes | Create a quote |
| GET | /v1/quotes/{quote} | Retrieve a quote |
| POST | /v1/quotes/{quote} | Update a quote |
| POST | /v1/quotes/{quote}/accept | Accept a quote |
| POST | /v1/quotes/{quote}/cancel | Cancel a quote |
| GET | /v1/quotes/{quote}/computed_upfront_line_items | Retrieve a quote's upfront line items |
| POST | /v1/quotes/{quote}/finalize | Finalize a quote |
| GET | /v1/quotes/{quote}/line_items | Retrieve a quote's line items |
| GET | /v1/quotes/{quote}/pdf | Download quote PDF |
### radar
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/radar/early_fraud_warnings | List all early fraud warnings |
| GET | /v1/radar/early_fraud_warnings/{early_fraud_warning} | Retrieve an early fraud warning |
| POST | /v1/radar/payment_evaluations | Create a Payment Evaluation |
| GET | /v1/radar/value_list_items | List all value list items |
| POST | /v1/radar/value_list_items | Create a value list item |
| DELETE | /v1/radar/value_list_items/{item} | Delete a value list item |
| GET | /v1/radar/value_list_items/{item} | Retrieve a value list item |
| GET | /v1/radar/value_lists | List all value lists |
| POST | /v1/radar/value_lists | Create a value list |
| DELETE | /v1/radar/value_lists/{value_list} | Delete a value list |
| GET | /v1/radar/value_lists/{value_list} | Retrieve a value list |
| POST | /v1/radar/value_lists/{value_list} | Update a value list |
### refunds
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/refunds | List all refunds |
| POST | /v1/refunds | Create customer balance refund |
| GET | /v1/refunds/{refund} | Retrieve a refund |
| POST | /v1/refunds/{refund} | Update a refund |
| POST | /v1/refunds/{refund}/cancel | Cancel a refund |
### reporting
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/reporting/report_runs | List all Report Runs |
| POST | /v1/reporting/report_runs | Create a Report Run |
| GET | /v1/reporting/report_runs/{report_run} | Retrieve a Report Run |
| GET | /v1/reporting/report_types | List all Report Types |
| GET | /v1/reporting/report_types/{report_type} | Retrieve a Report Type |
### reviews
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/reviews | List all open reviews |
| GET | /v1/reviews/{review} | Retrieve a review |
| POST | /v1/reviews/{review}/approve | Approve a review |
### setup_attempts
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/setup_attempts | List all SetupAttempts |
### setup_intents
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/setup_intents | List all SetupIntents |
| POST | /v1/setup_intents | Create a SetupIntent |
| GET | /v1/setup_intents/{intent} | Retrieve a SetupIntent |
| POST | /v1/setup_intents/{intent} | Update a SetupIntent |
| POST | /v1/setup_intents/{intent}/cancel | Cancel a SetupIntent |
| POST | /v1/setup_intents/{intent}/confirm | Confirm a SetupIntent |
| POST | /v1/setup_intents/{intent}/verify_microdeposits | Verify microdeposits on a SetupIntent |
### shipping_rates
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/shipping_rates | List all shipping rates |
| POST | /v1/shipping_rates | Create a shipping rate |
| GET | /v1/shipping_rates/{shipping_rate_token} | Retrieve a shipping rate |
| POST | /v1/shipping_rates/{shipping_rate_token} | Update a shipping rate |
### sigma
| Method | Path | Description |
|--------|------|-------------|
| POST | /v1/sigma/saved_queries/{id} | Update an existing Sigma Query |
| GET | /v1/sigma/scheduled_query_runs | List all scheduled query runs |
| GET | /v1/sigma/scheduled_query_runs/{scheduled_query_run} | Retrieve a scheduled query run |
### sources
| Method | Path | Description |
|--------|------|-------------|
| POST | /v1/sources | Shares a source |
| GET | /v1/sources/{source} | Retrieve a source |
| POST | /v1/sources/{source} | Update a source |
| GET | /v1/sources/{source}/mandate_notifications/{mandate_notification} | Retrieve a Source MandateNotification |
| GET | /v1/sources/{source}/source_transactions | <p>List source transactions for a given source.</p> |
| GET | /v1/sources/{source}/source_transactions/{source_transaction} | Retrieve a source transaction |
| POST | /v1/sources/{source}/verify | <p>Verify a given source.</p> |
### subscription_items
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/subscription_items | List all subscription items |
| POST | /v1/subscription_items | Create a subscription item |
| DELETE | /v1/subscription_items/{item} | Delete a subscription item |
| GET | /v1/subscription_items/{item} | Retrieve a subscription item |
| POST | /v1/subscription_items/{item} | Update a subscription item |
### subscription_schedules
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/subscription_schedules | List all schedules |
| POST | /v1/subscription_schedules | Create a schedule |
| GET | /v1/subscription_schedules/{schedule} | Retrieve a schedule |
| POST | /v1/subscription_schedules/{schedule} | Update a schedule |
| POST | /v1/subscription_schedules/{schedule}/cancel | Cancel a schedule |
| POST | /v1/subscription_schedules/{schedule}/release | Release a schedule |
### subscriptions
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/subscriptions | List subscriptions |
| POST | /v1/subscriptions | Create a subscription |
| GET | /v1/subscriptions/search | Search subscriptions |
| DELETE | /v1/subscriptions/{subscription_exposed_id} | Cancel a subscription |
| GET | /v1/subscriptions/{subscription_exposed_id} | Retrieve a subscription |
| POST | /v1/subscriptions/{subscription_exposed_id} | Update a subscription |
| DELETE | /v1/subscriptions/{subscription_exposed_id}/discount | Delete a subscription discount |
| POST | /v1/subscriptions/{subscription}/migrate | Migrate a subscription |
| POST | /v1/subscriptions/{subscription}/resume | Resume a subscription |
### tax
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/tax/associations/find | Find a Tax Association |
| POST | /v1/tax/calculations | Create a Tax Calculation |
| GET | /v1/tax/calculations/{calculation} | Retrieve a Tax Calculation |
| GET | /v1/tax/calculations/{calculation}/line_items | Retrieve a calculation's line items |
| GET | /v1/tax/registrations | List registrations |
| POST | /v1/tax/registrations | Create a registration |
| GET | /v1/tax/registrations/{id} | Retrieve a registration |
| POST | /v1/tax/registrations/{id} | Update a registration |
| GET | /v1/tax/settings | Retrieve settings |
| POST | /v1/tax/settings | Update settings |
| POST | /v1/tax/transactions/create_from_calculation | Create a transaction from a calculation |
| POST | /v1/tax/transactions/create_reversal | Create a reversal transaction |
| GET | /v1/tax/transactions/{transaction} | Retrieve a transaction |
| GET | /v1/tax/transactions/{transaction}/line_items | Retrieve a transaction's line items |
### tax_codes
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/tax_codes | List all tax codes |
| GET | /v1/tax_codes/{id} | Retrieve a tax code |
### tax_ids
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/tax_ids | List all tax IDs |
| POST | /v1/tax_ids | Create a tax ID |
| DELETE | /v1/tax_ids/{id} | Delete a tax ID |
| GET | /v1/tax_ids/{id} | Retrieve a tax ID |
### tax_rates
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/tax_rates | List all tax rates |
| POST | /v1/tax_rates | Create a tax rate |
| GET | /v1/tax_rates/{tax_rate} | Retrieve a tax rate |
| POST | /v1/tax_rates/{tax_rate} | Update a tax rate |
### terminal
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/terminal/configurations | List all Configurations |
| POST | /v1/terminal/configurations | Create a Configuration |
| DELETE | /v1/terminal/configurations/{configuration} | Delete a Configuration |
| GET | /v1/terminal/configurations/{configuration} | Retrieve a Configuration |
| POST | /v1/terminal/configurations/{configuration} | Update a Configuration |
| POST | /v1/terminal/connection_tokens | Create a Connection Token |
| GET | /v1/terminal/locations | List all Locations |
| POST | /v1/terminal/locations | Create a Location |
| DELETE | /v1/terminal/locations/{location} | Delete a Location |
| GET | /v1/terminal/locations/{location} | Retrieve a Location |
| POST | /v1/terminal/locations/{location} | Update a Location |
| POST | /v1/terminal/onboarding_links | Create an Onboarding Link |
| GET | /v1/terminal/readers | List all Readers |
| POST | /v1/terminal/readers | Create a Reader |
| DELETE | /v1/terminal/readers/{reader} | Delete a Reader |
| GET | /v1/terminal/readers/{reader} | Retrieve a Reader |
| POST | /v1/terminal/readers/{reader} | Update a Reader |
| POST | /v1/terminal/readers/{reader}/cancel_action | Cancel the current reader action |
| POST | /v1/terminal/readers/{reader}/collect_inputs | Collect inputs using a Reader |
| POST | /v1/terminal/readers/{reader}/collect_payment_method | Hand off a PaymentIntent to a Reader and collect card details |
| POST | /v1/terminal/readers/{reader}/confirm_payment_intent | Confirm a PaymentIntent on the Reader |
| POST | /v1/terminal/readers/{reader}/process_payment_intent | Hand-off a PaymentIntent to a Reader |
| POST | /v1/terminal/readers/{reader}/process_setup_intent | Hand-off a SetupIntent to a Reader |
| POST | /v1/terminal/readers/{reader}/refund_payment | Refund a Charge or a PaymentIntent in-person |
| POST | /v1/terminal/readers/{reader}/set_reader_display | Set reader display |
| POST | /v1/terminal/refunds | Create a refund using a Terminal-supported device. |
### test_helpers
| Method | Path | Description |
|--------|------|-------------|
| POST | /v1/test_helpers/confirmation_tokens | Create a test Confirmation Token |
| POST | /v1/test_helpers/customers/{customer}/fund_cash_balance | Fund a test mode cash balance |
| POST | /v1/test_helpers/issuing/authorizations | Create a test-mode authorization |
| POST | /v1/test_helpers/issuing/authorizations/{authorization}/capture | Capture a test-mode authorization |
| POST | /v1/test_helpers/issuing/authorizations/{authorization}/expire | Expire a test-mode authorization |
| POST | /v1/test_helpers/issuing/authorizations/{authorization}/finalize_amount | Finalize a test-mode authorization's amount |
| POST | /v1/test_helpers/issuing/authorizations/{authorization}/fraud_challenges/respond | Respond to fraud challenge |
| POST | /v1/test_helpers/issuing/authorizations/{authorization}/increment | Increment a test-mode authorization |
| POST | /v1/test_helpers/issuing/authorizations/{authorization}/reverse | Reverse a test-mode authorization |
| POST | /v1/test_helpers/issuing/cards/{card}/shipping/deliver | Deliver a testmode card |
| POST | /v1/test_helpers/issuing/cards/{card}/shipping/fail | Fail a testmode card |
| POST | /v1/test_helpers/issuing/cards/{card}/shipping/return | Return a testmode card |
| POST | /v1/test_helpers/issuing/cards/{card}/shipping/ship | Ship a testmode card |
| POST | /v1/test_helpers/issuing/cards/{card}/shipping/submit | Submit a testmode card |
| POST | /v1/test_helpers/issuing/personalization_designs/{personalization_design}/activate | Activate a testmode personalization design |
| POST | /v1/test_helpers/issuing/personalization_designs/{personalization_design}/deactivate | Deactivate a testmode personalization design |
| POST | /v1/test_helpers/issuing/personalization_designs/{personalization_design}/reject | Reject a testmode personalization design |
| POST | /v1/test_helpers/issuing/settlements | Create a test-mode settlement |
| POST | /v1/test_helpers/issuing/settlements/{settlement}/complete | Complete a test-mode settlement |
| POST | /v1/test_helpers/issuing/transactions/create_force_capture | Create a test-mode force capture |
| POST | /v1/test_helpers/issuing/transactions/create_unlinked_refund | Create a test-mode unlinked refund |
| POST | /v1/test_helpers/issuing/transactions/{transaction}/refund | Refund a test-mode transaction |
| POST | /v1/test_helpers/refunds/{refund}/expire | Expire a pending refund. |
| POST | /v1/test_helpers/terminal/readers/{reader}/present_payment_method | Simulate presenting a payment method |
| POST | /v1/test_helpers/terminal/readers/{reader}/succeed_input_collection | Simulate a successful input collection |
| POST | /v1/test_helpers/terminal/readers/{reader}/timeout_input_collection | Simulate an input collection timeout |
| GET | /v1/test_helpers/test_clocks | List all test clocks |
| POST | /v1/test_helpers/test_clocks | Create a test clock |
| DELETE | /v1/test_helpers/test_clocks/{test_clock} | Delete a test clock |
| GET | /v1/test_helpers/test_clocks/{test_clock} | Retrieve a test clock |
| POST | /v1/test_helpers/test_clocks/{test_clock}/advance | Advance a test clock |
| POST | /v1/test_helpers/treasury/inbound_transfers/{id}/fail | Test mode: Fail an InboundTransfer |
| POST | /v1/test_helpers/treasury/inbound_transfers/{id}/return | Test mode: Return an InboundTransfer |
| POST | /v1/test_helpers/treasury/inbound_transfers/{id}/succeed | Test mode: Succeed an InboundTransfer |
| POST | /v1/test_helpers/treasury/outbound_payments/{id} | Test mode: Update an OutboundPayment |
| POST | /v1/test_helpers/treasury/outbound_payments/{id}/fail | Test mode: Fail an OutboundPayment |
| POST | /v1/test_helpers/treasury/outbound_payments/{id}/post | Test mode: Post an OutboundPayment |
| POST | /v1/test_helpers/treasury/outbound_payments/{id}/return | Test mode: Return an OutboundPayment |
| POST | /v1/test_helpers/treasury/outbound_transfers/{outbound_transfer} | Test mode: Update an OutboundTransfer |
| POST | /v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/fail | Test mode: Fail an OutboundTransfer |
| POST | /v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/post | Test mode: Post an OutboundTransfer |
| POST | /v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/return | Test mode: Return an OutboundTransfer |
| POST | /v1/test_helpers/treasury/received_credits | Test mode: Create a ReceivedCredit |
| POST | /v1/test_helpers/treasury/received_debits | Test mode: Create a ReceivedDebit |
### tokens
| Method | Path | Description |
|--------|------|-------------|
| POST | /v1/tokens | Create a CVC update token |
| GET | /v1/tokens/{token} | Retrieve a token |
### topups
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/topups | List all top-ups |
| POST | /v1/topups | Create a top-up |
| GET | /v1/topups/{topup} | Retrieve a top-up |
| POST | /v1/topups/{topup} | Update a top-up |
| POST | /v1/topups/{topup}/cancel | Cancel a top-up |
### transfers
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/transfers | List all transfers |
| POST | /v1/transfers | Create a transfer |
| GET | /v1/transfers/{id}/reversals | List all reversals |
| POST | /v1/transfers/{id}/reversals | Create a transfer reversal |
| GET | /v1/transfers/{transfer} | Retrieve a transfer |
| POST | /v1/transfers/{transfer} | Update a transfer |
| GET | /v1/transfers/{transfer}/reversals/{id} | Retrieve a reversal |
| POST | /v1/transfers/{transfer}/reversals/{id} | Update a reversal |
### treasury
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/treasury/credit_reversals | List all CreditReversals |
| POST | /v1/treasury/credit_reversals | Create a CreditReversal |
| GET | /v1/treasury/credit_reversals/{credit_reversal} | Retrieve a CreditReversal |
| GET | /v1/treasury/debit_reversals | List all DebitReversals |
| POST | /v1/treasury/debit_reversals | Create a DebitReversal |
| GET | /v1/treasury/debit_reversals/{debit_reversal} | Retrieve a DebitReversal |
| GET | /v1/treasury/financial_accounts | List all FinancialAccounts |
| POST | /v1/treasury/financial_accounts | Create a FinancialAccount |
| GET | /v1/treasury/financial_accounts/{financial_account} | Retrieve a FinancialAccount |
| POST | /v1/treasury/financial_accounts/{financial_account} | Update a FinancialAccount |
| POST | /v1/treasury/financial_accounts/{financial_account}/close | Close a FinancialAccount |
| GET | /v1/treasury/financial_accounts/{financial_account}/features | Retrieve FinancialAccount Features |
| POST | /v1/treasury/financial_accounts/{financial_account}/features | Update FinancialAccount Features |
| GET | /v1/treasury/inbound_transfers | List all InboundTransfers |
| POST | /v1/treasury/inbound_transfers | Create an InboundTransfer |
| GET | /v1/treasury/inbound_transfers/{id} | Retrieve an InboundTransfer |
| POST | /v1/treasury/inbound_transfers/{inbound_transfer}/cancel | Cancel an InboundTransfer |
| GET | /v1/treasury/outbound_payments | List all OutboundPayments |
| POST | /v1/treasury/outbound_payments | Create an OutboundPayment |
| GET | /v1/treasury/outbound_payments/{id} | Retrieve an OutboundPayment |
| POST | /v1/treasury/outbound_payments/{id}/cancel | Cancel an OutboundPayment |
| GET | /v1/treasury/outbound_transfers | List all OutboundTransfers |
| POST | /v1/treasury/outbound_transfers | Create an OutboundTransfer |
| GET | /v1/treasury/outbound_transfers/{outbound_transfer} | Retrieve an OutboundTransfer |
| POST | /v1/treasury/outbound_transfers/{outbound_transfer}/cancel | Cancel an OutboundTransfer |
| GET | /v1/treasury/received_credits | List all ReceivedCredits |
| GET | /v1/treasury/received_credits/{id} | Retrieve a ReceivedCredit |
| GET | /v1/treasury/received_debits | List all ReceivedDebits |
| GET | /v1/treasury/received_debits/{id} | Retrieve a ReceivedDebit |
| GET | /v1/treasury/transaction_entries | List all TransactionEntries |
| GET | /v1/treasury/transaction_entries/{id} | Retrieve a TransactionEntry |
| GET | /v1/treasury/transactions | List all Transactions |
| GET | /v1/treasury/transactions/{id} | Retrieve a Transaction |
### webhook_endpoints
| Method | Path | Description |
|--------|------|-------------|
| GET | /v1/webhook_endpoints | List all webhook endpoints |
| POST | /v1/webhook_endpoints | Create a webhook endpoint |
| DELETE | /v1/webhook_endpoints/{webhook_endpoint} | Delete a webhook endpoint |
| GET | /v1/webhook_endpoints/{webhook_endpoint} | Retrieve a webhook endpoint |
| POST | /v1/webhook_endpoints/{webhook_endpoint} | Update a webhook endpoint |
## Common Questions
Match user requests to endpoints in references/api-spec.lap. Key patterns:
- "List all account?" -> GET /v1/account
- "Create a account_link?" -> POST /v1/account_links
- "Create a account_session?" -> POST /v1/account_sessions
- "List all accounts?" -> GET /v1/accounts
- "Create a account?" -> POST /v1/accounts
- "Delete a account?" -> DELETE /v1/accounts/{account}
- "Get account details?" -> GET /v1/accounts/{account}
- "Create a bank_account?" -> POST /v1/accounts/{account}/bank_accounts
- "Delete a bank_account?" -> DELETE /v1/accounts/{account}/bank_accounts/{id}
- "Get bank_account details?" -> GET /v1/accounts/{account}/bank_accounts/{id}
- "List all capabilities?" -> GET /v1/accounts/{account}/capabilities
- "Get capability details?" -> GET /v1/accounts/{account}/capabilities/{capability}
- "List all external_accounts?" -> GET /v1/accounts/{account}/external_accounts
- "Create a external_account?" -> POST /v1/accounts/{account}/external_accounts
- "Delete a external_account?" -> DELETE /v1/accounts/{account}/external_accounts/{id}
- "Get external_account details?" -> GET /v1/accounts/{account}/external_accounts/{id}
- "Create a login_link?" -> POST /v1/accounts/{account}/login_links
- "List all people?" -> GET /v1/accounts/{account}/people
- "Create a people?" -> POST /v1/accounts/{account}/people
- "Delete a people?" -> DELETE /v1/accounts/{account}/people/{person}
- "Get people details?" -> GET /v1/accounts/{account}/people/{person}
- "List all persons?" -> GET /v1/accounts/{account}/persons
- "Create a person?" -> POST /v1/accounts/{account}/persons
- "Delete a person?" -> DELETE /v1/accounts/{account}/persons/{person}
- "Get person details?" -> GET /v1/accounts/{account}/persons/{person}
- "Create a reject?" -> POST /v1/accounts/{account}/reject
- "List all domains?" -> GET /v1/apple_pay/domains
- "Create a domain?" -> POST /v1/apple_pay/domains
- "Delete a domain?" -> DELETE /v1/apple_pay/domains/{domain}
- "Get domain details?" -> GET /v1/apple_pay/domains/{domain}
- "List all application_fees?" -> GET /v1/application_fees
- "Get refund details?" -> GET /v1/application_fees/{fee}/refunds/{id}
- "Get application_fee details?" -> GET /v1/application_fees/{id}
- "Create a refund?" -> POST /v1/application_fees/{id}/refund
- "List all refunds?" -> GET /v1/application_fees/{id}/refunds
- "Create a refund?" -> POST /v1/application_fees/{id}/refunds
- "List all secrets?" -> GET /v1/apps/secrets
- "Create a secret?" -> POST /v1/apps/secrets
- "Create a delete?" -> POST /v1/apps/secrets/delete
- "List all find?" -> GET /v1/apps/secrets/find
- "List all balance?" -> GET /v1/balance
- "List all history?" -> GET /v1/balance/history
- "Get history details?" -> GET /v1/balance/history/{id}
- "List all balance_settings?" -> GET /v1/balance_settings
- "Create a balance_setting?" -> POST /v1/balance_settings
- "List all balance_transactions?" -> GET /v1/balance_transactions
- "Get balance_transaction details?" -> GET /v1/balance_transactions/{id}
- "List all alerts?" -> GET /v1/billing/alerts
- "Create a alert?" -> POST /v1/billing/alerts
- "Get alert details?" -> GET /v1/billing/alerts/{id}
- "Create a activate?" -> POST /v1/billing/alerts/{id}/activate
- "Create a archive?" -> POST /v1/billing/alerts/{id}/archive
- "Create a deactivate?" -> POST /v1/billing/alerts/{id}/deactivate
- "List all credit_balance_summary?" -> GET /v1/billing/credit_balance_summary
- "List all credit_balance_transactions?" -> GET /v1/billing/credit_balance_transactions
- "Get credit_balance_transaction details?" -> GET /v1/billing/credit_balance_transactions/{id}
- "List all credit_grants?" -> GET /v1/billing/credit_grants
- "Create a credit_grant?" -> POST /v1/billing/credit_grants
- "Get credit_grant details?" -> GET /v1/billing/credit_grants/{id}
- "Create a expire?" -> POST /v1/billing/credit_grants/{id}/expire
- "Create a void?" -> POST /v1/billing/credit_grants/{id}/void
- "Create a meter_event_adjustment?" -> POST /v1/billing/meter_event_adjustments
- "Create a meter_event?" -> POST /v1/billing/meter_events
- "List all meters?" -> GET /v1/billing/meters
- "Create a meter?" -> POST /v1/billing/meters
- "Get meter details?" -> GET /v1/billing/meters/{id}
- "Create a deactivate?" -> POST /v1/billing/meters/{id}/deactivate
- "List all event_summaries?" -> GET /v1/billing/meters/{id}/event_summaries
- "Create a reactivate?" -> POST /v1/billing/meters/{id}/reactivate
- "List all configurations?" -> GET /v1/billing_portal/configurations
- "Create a configuration?" -> POST /v1/billing_portal/configurations
- "Get configuration details?" -> GET /v1/billing_portal/configurations/{configuration}
- "Create a session?" -> POST /v1/billing_portal/sessions
- "List all charges?" -> GET /v1/charges
- "Create a charge?" -> POST /v1/charges
- "Search search?" -> GET /v1/charges/search
- "Get charge details?" -> GET /v1/charges/{charge}
- "Create a capture?" -> POST /v1/charges/{charge}/capture
- "List all dispute?" -> GET /v1/charges/{charge}/dispute
- "Create a dispute?" -> POST /v1/charges/{charge}/dispute
- "Create a close?" -> POST /v1/charges/{charge}/dispute/close
- "Create a refund?" -> POST /v1/charges/{charge}/refund
- "List all refunds?" -> GET /v1/charges/{charge}/refunds
- "Create a refund?" -> POST /v1/charges/{charge}/refunds
- "Get refund details?" -> GET /v1/charges/{charge}/refunds/{refund}
- "List all sessions?" -> GET /v1/checkout/sessions
- "Create a session?" -> POST /v1/checkout/sessions
- "Get session details?" -> GET /v1/checkout/sessions/{session}
- "Create a expire?" -> POST /v1/checkout/sessions/{session}/expire
- "List all line_items?" -> GET /v1/checkout/sessions/{session}/line_items
- "List all orders?" -> GET /v1/climate/orders
- "Create a order?" -> POST /v1/climate/orders
- "Get order details?" -> GET /v1/climate/orders/{order}
- "Create a cancel?" -> POST /v1/climate/orders/{order}/cancel
- "List all products?" -> GET /v1/climate/products
- "Get product details?" -> GET /v1/climate/products/{product}
- "List all suppliers?" -> GET /v1/climate/suppliers
- "Get supplier details?" -> GET /v1/climate/suppliers/{supplier}
- "Get confirmation_token details?" -> GET /v1/confirmation_tokens/{confirmation_token}
- "List all country_specs?" -> GET /v1/country_specs
- "Get country_spec details?" -> GET /v1/country_specs/{country}
- "List all coupons?" -> GET /v1/coupons
- "Create a coupon?" -> POST /v1/coupons
- "Delete a coupon?" -> DELETE /v1/coupons/{coupon}
- "Get coupon details?" -> GET /v1/coupons/{coupon}
- "List all credit_notes?" -> GET /v1/credit_notes
- "Create a credit_note?" -> POST /v1/credit_notes
- "List all preview?" -> GET /v1/credit_notes/preview
- "List all lines?" -> GET /v1/credit_notes/preview/lines
- "List all lines?" -> GET /v1/credit_notes/{credit_note}/lines
- "Get credit_note details?" -> GET /v1/credit_notes/{id}
- "Create a void?" -> POST /v1/credit_notes/{id}/void
- "Create a customer_session?" -> POST /v1/customer_sessions
- "List all customers?" -> GET /v1/customers
- "Create a customer?" -> POST /v1/customers
- "Search search?" -> GET /v1/customers/search
- "Delete a customer?" -> DELETE /v1/customers/{customer}
- "Get customer details?" -> GET /v1/customers/{customer}
- "List all balance_transactions?" -> GET /v1/customers/{customer}/balance_transactions
- "Create a balance_transaction?" -> POST /v1/customers/{customer}/balance_transactions
- "Get balance_transaction details?" -> GET /v1/customers/{customer}/balance_transactions/{transaction}
- "List all bank_accounts?" -> GET /v1/customers/{customer}/bank_accounts
- "Create a bank_account?" -> POST /v1/customers/{customer}/bank_accounts
- "Delete a bank_account?" -> DELETE /v1/customers/{customer}/bank_accounts/{id}
- "Get bank_account details?" -> GET /v1/customers/{customer}/bank_accounts/{id}
- "Create a verify?" -> POST /v1/customers/{customer}/bank_accounts/{id}/verify
- "List all cards?" -> GET /v1/customers/{customer}/cards
- "Create a card?" -> POST /v1/customers/{customer}/cards
- "Delete a card?" -> DELETE /v1/customers/{customer}/cards/{id}
- "Get card details?" -> GET /v1/customers/{customer}/cards/{id}
- "List all cash_balance?" -> GET /v1/customers/{customer}/cash_balance
- "Create a cash_balance?" -> POST /v1/customers/{customer}/cash_balance
- "List all cash_balance_transactions?" -> GET /v1/customers/{customer}/cash_balance_transactions
- "Get cash_balance_transaction details?" -> GET /v1/customers/{customer}/cash_balance_transactions/{transaction}
- "List all discount?" -> GET /v1/customers/{customer}/discount
- "Create a funding_instruction?" -> POST /v1/customers/{customer}/funding_instructions
- "List all payment_methods?" -> GET /v1/customers/{customer}/payment_methods
- "Get payment_method details?" -> GET /v1/customers/{customer}/payment_methods/{payment_method}
- "List all sources?" -> GET /v1/customers/{customer}/sources
- "Create a source?" -> POST /v1/customers/{customer}/sources
- "Delete a source?" -> DELETE /v1/customers/{customer}/sources/{id}
- "Get source details?" -> GET /v1/customers/{customer}/sources/{id}
- "Create a verify?" -> POST /v1/customers/{customer}/sources/{id}/verify
- "List all subscriptions?" -> GET /v1/customers/{customer}/subscriptions
- "Create a subscription?" -> POST /v1/customers/{customer}/subscriptions
- "Delete a subscription?" -> DELETE /v1/customers/{customer}/subscriptions/{subscription_exposed_id}
- "Get subscription details?" -> GET /v1/customers/{customer}/subscriptions/{subscription_exposed_id}
- "List all discount?" -> GET /v1/customers/{customer}/subscriptions/{subscription_exposed_id}/discount
- "List all tax_ids?" -> GET /v1/customers/{customer}/tax_ids
- "Create a tax_id?" -> POST /v1/customers/{customer}/tax_ids
- "Delete a tax_id?" -> DELETE /v1/customers/{customer}/tax_ids/{id}
- "Get tax_id details?" -> GET /v1/customers/{customer}/tax_ids/{id}
- "List all disputes?" -> GET /v1/disputes
- "Get dispute details?" -> GET /v1/disputes/{dispute}
- "Create a close?" -> POST /v1/disputes/{dispute}/close
- "List all active_entitlements?" -> GET /v1/entitlements/active_entitlements
- "Get active_entitlement details?" -> GET /v1/entitlements/active_entitlements/{id}
- "List all features?" -> GET /v1/entitlements/features
- "Create a feature?" -> POST /v1/entitlements/features
- "Get feature details?" -> GET /v1/entitlements/features/{id}
- "Create a ephemeral_key?" -> POST /v1/ephemeral_keys
- "Delete a ephemeral_key?" -> DELETE /v1/ephemeral_keys/{key}
- "List all events?" -> GET /v1/events
- "Get event details?" -> GET /v1/events/{id}
- "List all exchange_rates?" -> GET /v1/exchange_rates
- "Get exchange_rate details?" -> GET /v1/exchange_rates/{rate_id}
- "List all file_links?" -> GET /v1/file_links
- "Create a file_link?" -> POST /v1/file_links
- "Get file_link details?" -> GET /v1/file_links/{link}
- "List all files?" -> GET /v1/files
- "Create a file?" -> POST /v1/files
- "Get file details?" -> GET /v1/files/{file}
- "List all accounts?" -> GET /v1/financial_connections/accounts
- "Get account details?" -> GET /v1/financial_connections/accounts/{account}
- "Create a disconnect?" -> POST /v1/financial_connections/accounts/{account}/disconnect
- "List all owners?" -> GET /v1/financial_connections/accounts/{account}/owners
- "Create a refresh?" -> POST /v1/financial_connections/accounts/{account}/refresh
- "Create a subscribe?" -> POST /v1/financial_connections/accounts/{account}/subscribe
- "Create a unsubscribe?" -> POST /v1/financial_connections/accounts/{account}/unsubscribe
- "Create a session?" -> POST /v1/financial_connections/sessions
- "Get session details?" -> GET /v1/financial_connections/sessions/{session}
- "List all transactions?" -> GET /v1/financial_connections/transactions
- "Get transaction details?" -> GET /v1/financial_connections/transactions/{transaction}
- "List all requests?" -> GET /v1/forwarding/requests
- "Create a request?" -> POST /v1/forwarding/requests
- "Get request details?" -> GET /v1/forwarding/requests/{id}
- "List all verification_reports?" -> GET /v1/identity/verification_reports
- "Get verification_report details?" -> GET /v1/identity/verification_reports/{report}
- "List all verification_sessions?" -> GET /v1/identity/verification_sessions
- "Create a verification_session?" -> POST /v1/identity/verification_sessions
- "Get verification_session details?" -> GET /v1/identity/verification_sessions/{session}
- "Create a cancel?" -> POST /v1/identity/verification_sessions/{session}/cancel
- "Create a redact?" -> POST /v1/identity/verification_sessions/{session}/redact
- "List all invoice_payments?" -> GET /v1/invoice_payments
- "Get invoice_payment details?" -> GET /v1/invoice_payments/{invoice_payment}
- "List all invoice_rendering_templates?" -> GET /v1/invoice_rendering_templates
- "Get invoice_rendering_template details?" -> GET /v1/invoice_rendering_templates/{template}
- "Create a archive?" -> POST /v1/invoice_rendering_templates/{template}/archive
- "Create a unarchive?" -> POST /v1/invoice_rendering_templates/{template}/unarchive
- "List all invoiceitems?" -> GET /v1/invoiceitems
- "Create a invoiceitem?" -> POST /v1/invoiceitems
- "Delete a invoiceitem?" -> DELETE /v1/invoiceitems/{invoiceitem}
- "Get invoiceitem details?" -> GET /v1/invoiceitems/{invoiceitem}
- "List all invoices?" -> GET /v1/invoices
- "Create a invoice?" -> POST /v1/invoices
- "Create a create_preview?" -> POST /v1/invoices/create_preview
- "Search search?" -> GET /v1/invoices/search
- "Delete a invoice?" -> DELETE /v1/invoices/{invoice}
- "Get invoice details?" -> GET /v1/invoices/{invoice}
- "Create a add_line?" -> POST /v1/invoices/{invoice}/add_lines
- "Create a attach_payment?" -> POST /v1/invoices/{invoice}/attach_payment
- "Create a finalize?" -> POST /v1/invoices/{invoice}/finalize
- "List all lines?" -> GET /v1/invoices/{invoice}/lines
- "Create a mark_uncollectible?" -> POST /v1/invoices/{invoice}/mark_uncollectible
- "Create a pay?" -> POST /v1/invoices/{invoice}/pay
- "Create a remove_line?" -> POST /v1/invoices/{invoice}/remove_lines
- "Create a send?" -> POST /v1/invoices/{invoice}/send
- "Create a update_line?" -> POST /v1/invoices/{invoice}/update_lines
- "Create a void?" -> POST /v1/invoices/{invoice}/void
- "List all authorizations?" -> GET /v1/issuing/authorizations
- "Get authorization details?" -> GET /v1/issuing/authorizations/{authorization}
- "Create a approve?" -> POST /v1/issuing/authorizations/{authorization}/approve
- "Create a decline?" -> POST /v1/issuing/authorizations/{authorization}/decline
- "List all cardholders?" -> GET /v1/issuing/cardholders
- "Create a cardholder?" -> POST /v1/issuing/cardholders
- "Get cardholder details?" -> GET /v1/issuing/cardholders/{cardholder}
- "List all cards?" -> GET /v1/issuing/cards
- "Create a card?" -> POST /v1/issuing/cards
- "Get card details?" -> GET /v1/issuing/cards/{card}
- "List all disputes?" -> GET /v1/issuing/disputes
- "Create a dispute?" -> POST /v1/issuing/disputes
- "Get dispute details?" -> GET /v1/issuing/disputes/{dispute}
- "Create a submit?" -> POST /v1/issuing/disputes/{dispute}/submit
- "List all personalization_designs?" -> GET /v1/issuing/personalization_designs
- "Create a personalization_design?" -> POST /v1/issuing/personalization_designs
- "Get personalization_design details?" -> GET /v1/issuing/personalization_designs/{personalization_design}
- "List all physical_bundles?" -> GET /v1/issuing/physical_bundles
- "Get physical_bundle details?" -> GET /v1/issuing/physical_bundles/{physical_bundle}
- "Get settlement details?" -> GET /v1/issuing/settlements/{settlement}
- "List all tokens?" -> GET /v1/issuing/tokens
- "Get token details?" -> GET /v1/issuing/tokens/{token}
- "List all transactions?" -> GET /v1/issuing/transactions
- "Get transaction details?" -> GET /v1/issuing/transactions/{transaction}
- "Create a link_account_session?" -> POST /v1/link_account_sessions
- "Get link_account_session details?" -> GET /v1/link_account_sessions/{session}
- "List all linked_accounts?" -> GET /v1/linked_accounts
- "Get linked_account details?" -> GET /v1/linked_accounts/{account}
- "Create a disconnect?" -> POST /v1/linked_accounts/{account}/disconnect
- "List all owners?" -> GET /v1/linked_accounts/{account}/owners
- "Create a refresh?" -> POST /v1/linked_accounts/{account}/refresh
- "Get mandate details?" -> GET /v1/mandates/{mandate}
- "List all payment_attempt_records?" -> GET /v1/payment_attempt_records
- "Get payment_attempt_record details?" -> GET /v1/payment_attempt_records/{id}
- "List all payment_intents?" -> GET /v1/payment_intents
- "Create a payment_intent?" -> POST /v1/payment_intents
- "Search search?" -> GET /v1/payment_intents/search
- "Get payment_intent details?" -> GET /v1/payment_intents/{intent}
- "List all amount_details_line_items?" -> GET /v1/payment_intents/{intent}/amount_details_line_items
- "Create a apply_customer_balance?" -> POST /v1/payment_intents/{intent}/apply_customer_balance
- "Create a cancel?" -> POST /v1/payment_intents/{intent}/cancel
- "Create a capture?" -> POST /v1/payment_intents/{intent}/capture
- "Create a confirm?" -> POST /v1/payment_intents/{intent}/confirm
- "Create a increment_authorization?" -> POST /v1/payment_intents/{intent}/increment_authorization
- "Create a verify_microdeposit?" -> POST /v1/payment_intents/{intent}/verify_microdeposits
- "List all payment_links?" -> GET /v1/payment_links
- "Create a payment_link?" -> POST /v1/payment_links
- "Get payment_link details?" -> GET /v1/payment_links/{payment_link}
- "List all line_items?" -> GET /v1/payment_links/{payment_link}/line_items
- "List all payment_method_configurations?" -> GET /v1/payment_method_configurations
- "Create a payment_method_configuration?" -> POST /v1/payment_method_configurations
- "Get payment_method_configuration details?" -> GET /v1/payment_method_configurations/{configuration}
- "List all payment_method_domains?" -> GET /v1/payment_method_domains
- "Create a payment_method_domain?" -> POST /v1/payment_method_domains
- "Get payment_method_domain details?" -> GET /v1/payment_method_domains/{payment_method_domain}
- "Create a validate?" -> POST /v1/payment_method_domains/{payment_method_domain}/validate
- "List all payment_methods?" -> GET /v1/payment_methods
- "Create a payment_method?" -> POST /v1/payment_methods
- "Get payment_method details?" -> GET /v1/payment_methods/{payment_method}
- "Create a attach?" -> POST /v1/payment_methods/{payment_method}/attach
- "Create a detach?" -> POST /v1/payment_methods/{payment_method}/detach
- "Create a report_payment?" -> POST /v1/payment_records/report_payment
- "Get payment_record details?" -> GET /v1/payment_records/{id}
- "Create a report_payment_attempt?" -> POST /v1/payment_records/{id}/report_payment_attempt
- "Create a report_payment_attempt_canceled?" -> POST /v1/payment_records/{id}/report_payment_attempt_canceled
- "Create a report_payment_attempt_failed?" -> POST /v1/payment_records/{id}/report_payment_attempt_failed
- "Create a report_payment_attempt_guaranteed?" -> POST /v1/payment_records/{id}/report_payment_attempt_guaranteed
- "Create a report_payment_attempt_informational?" -> POST /v1/payment_records/{id}/report_payment_attempt_informational
- "Create a report_refund?" -> POST /v1/payment_records/{id}/report_refund
- "List all payouts?" -> GET /v1/payouts
- "Create a payout?" -> POST /v1/payouts
- "Get payout details?" -> GET /v1/payouts/{payout}
- "Create a cancel?" -> POST /v1/payouts/{payout}/cancel
- "Create a reverse?" -> POST /v1/payouts/{payout}/reverse
- "List all plans?" -> GET /v1/plans
- "Create a plan?" -> POST /v1/plans
- "Delete a plan?" -> DELETE /v1/plans/{plan}
- "Get plan details?" -> GET /v1/plans/{plan}
- "List all prices?" -> GET /v1/prices
- "Create a price?" -> POST /v1/prices
- "Search search?" -> GET /v1/prices/search
- "Get price details?" -> GET /v1/prices/{price}
- "List all products?" -> GET /v1/products
- "Create a product?" -> POST /v1/products
- "Search search?" -> GET /v1/products/search
- "Delete a product?" -> DELETE /v1/products/{id}
- "Get product details?" -> GET /v1/products/{id}
- "List all features?" -> GET /v1/products/{product}/features
- "Create a feature?" -> POST /v1/products/{product}/features
- "Delete a feature?" -> DELETE /v1/products/{product}/features/{id}
- "Get feature details?" -> GET /v1/products/{product}/features/{id}
- "List all promotion_codes?" -> GET /v1/promotion_codes
- "Create a promotion_code?" -> POST /v1/promotion_codes
- "Get promotion_code details?" -> GET /v1/promotion_codes/{promotion_code}
- "List all quotes?" -> GET /v1/quotes
- "Create a quote?" -> POST /v1/quotes
- "Get quote details?" -> GET /v1/quotes/{quote}
- "Create a accept?" -> POST /v1/quotes/{quote}/accept
- "Create a cancel?" -> POST /v1/quotes/{quote}/cancel
- "List all computed_upfront_line_items?" -> GET /v1/quotes/{quote}/computed_upfront_line_items
- "Create a finalize?" -> POST /v1/quotes/{quote}/finalize
- "List all line_items?" -> GET /v1/quotes/{quote}/line_items
- "List all pdf?" -> GET /v1/quotes/{quote}/pdf
- "List all early_fraud_warnings?" -> GET /v1/radar/early_fraud_warnings
- "Get early_fraud_warning details?" -> GET /v1/radar/early_fraud_warnings/{early_fraud_warning}
- "Create a payment_evaluation?" -> POST /v1/radar/payment_evaluations
- "List all value_list_items?" -> GET /v1/radar/value_list_items
- "Create a value_list_item?" -> POST /v1/radar/value_list_items
- "Delete a value_list_item?" -> DELETE /v1/radar/value_list_items/{item}
- "Get value_list_item details?" -> GET /v1/radar/value_list_items/{item}
- "List all value_lists?" -> GET /v1/radar/value_lists
- "Create a value_list?" -> POST /v1/radar/value_lists
- "Delete a value_list?" -> DELETE /v1/radar/value_lists/{value_list}
- "Get value_list details?" -> GET /v1/radar/value_lists/{value_list}
- "List all refunds?" -> GET /v1/refunds
- "Create a refund?" -> POST /v1/refunds
- "Get refund details?" -> GET /v1/refunds/{refund}
- "Create a cancel?" -> POST /v1/refunds/{refund}/cancel
- "List all report_runs?" -> GET /v1/reporting/report_runs
- "Create a report_run?" -> POST /v1/reporting/report_runs
- "Get report_run details?" -> GET /v1/reporting/report_runs/{report_run}
- "List all report_types?" -> GET /v1/reporting/report_types
- "Get report_type details?" -> GET /v1/reporting/report_types/{report_type}
- "List all reviews?" -> GET /v1/reviews
- "Get review details?" -> GET /v1/reviews/{review}
- "Create a approve?" -> POST /v1/reviews/{review}/approve
- "List all setup_attempts?" -> GET /v1/setup_attempts
- "List all setup_intents?" -> GET /v1/setup_intents
- "Create a setup_intent?" -> POST /v1/setup_intents
- "Get setup_intent details?" -> GET /v1/setup_intents/{intent}
- "Create a cancel?" -> POST /v1/setup_intents/{intent}/cancel
- "Create a confirm?" -> POST /v1/setup_intents/{intent}/confirm
- "Create a verify_microdeposit?" -> POST /v1/setup_intents/{intent}/verify_microdeposits
- "List all shipping_rates?" -> GET /v1/shipping_rates
- "Create a shipping_rate?" -> POST /v1/shipping_rates
- "Get shipping_rate details?" -> GET /v1/shipping_rates/{shipping_rate_token}
- "List all scheduled_query_runs?" -> GET /v1/sigma/scheduled_query_runs
- "Get scheduled_query_run details?" -> GET /v1/sigma/scheduled_query_runs/{scheduled_query_run}
- "Create a source?" -> POST /v1/sources
- "Get source details?" -> GET /v1/sources/{source}
- "Get mandate_notification details?" -> GET /v1/sources/{source}/mandate_notifications/{mandate_notification}
- "List all source_transactions?" -> GET /v1/sources/{source}/source_transactions
- "Get source_transaction details?" -> GET /v1/sources/{source}/source_transactions/{source_transaction}
- "Create a verify?" -> POST /v1/sources/{source}/verify
- "List all subscription_items?" -> GET /v1/subscription_items
- "Create a subscription_item?" -> POST /v1/subscription_items
- "Delete a subscription_item?" -> DELETE /v1/subscription_items/{item}
- "Get subscription_item details?" -> GET /v1/subscription_items/{item}
- "List all subscription_schedules?" -> GET /v1/subscription_schedules
- "Create a subscription_schedule?" -> POST /v1/subscription_schedules
- "Get subscription_schedule details?" -> GET /v1/subscription_schedules/{schedule}
- "Create a cancel?" -> POST /v1/subscription_schedules/{schedule}/cancel
- "Create a release?" -> POST /v1/subscription_schedules/{schedule}/release
- "List all subscriptions?" -> GET /v1/subscriptions
- "Create a subscription?" -> POST /v1/subscriptions
- "Search search?" -> GET /v1/subscriptions/search
- "Delete a subscription?" -> DELETE /v1/subscriptions/{subscription_exposed_id}
- "Get subscription details?" -> GET /v1/subscriptions/{subscription_exposed_id}
- "Create a migrate?" -> POST /v1/subscriptions/{subscription}/migrate
- "Create a resume?" -> POST /v1/subscriptions/{subscription}/resume
- "List all find?" -> GET /v1/tax/associations/find
- "Create a calculation?" -> POST /v1/tax/calculations
- "Get calculation details?" -> GET /v1/tax/calculations/{calculation}
- "List all line_items?" -> GET /v1/tax/calculations/{calculation}/line_items
- "List all registrations?" -> GET /v1/tax/registrations
- "Create a registration?" -> POST /v1/tax/registrations
- "Get registration details?" -> GET /v1/tax/registrations/{id}
- "List all settings?" -> GET /v1/tax/settings
- "Create a setting?" -> POST /v1/tax/settings
- "Create a create_from_calculation?" -> POST /v1/tax/transactions/create_from_calculation
- "Create a create_reversal?" -> POST /v1/tax/transactions/create_reversal
- "Get transaction details?" -> GET /v1/tax/transactions/{transaction}
- "List all line_items?" -> GET /v1/tax/transactions/{transaction}/line_items
- "List all tax_codes?" -> GET /v1/tax_codes
- "Get tax_code details?" -> GET /v1/tax_codes/{id}
- "List all tax_ids?" -> GET /v1/tax_ids
- "Create a tax_id?" -> POST /v1/tax_ids
- "Delete a tax_id?" -> DELETE /v1/tax_ids/{id}
- "Get tax_id details?" -> GET /v1/tax_ids/{id}
- "List all tax_rates?" -> GET /v1/tax_rates
- "Create a tax_rate?" -> POST /v1/tax_rates
- "Get tax_rate details?" -> GET /v1/tax_rates/{tax_rate}
- "List all configurations?" -> GET /v1/terminal/configurations
- "Create a configuration?" -> POST /v1/terminal/configurations
- "Delete a configuration?" -> DELETE /v1/terminal/configurations/{configuration}
- "Get configuration details?" -> GET /v1/terminal/configurations/{configuration}
- "Create a connection_token?" -> POST /v1/terminal/connection_tokens
- "List all locations?" -> GET /v1/terminal/locations
- "Create a location?" -> POST /v1/terminal/locations
- "Delete a location?" -> DELETE /v1/terminal/locations/{location}
- "Get location details?" -> GET /v1/terminal/locations/{location}
- "Create a onboarding_link?" -> POST /v1/terminal/onboarding_links
- "List all readers?" -> GET /v1/terminal/readers
- "Create a reader?" -> POST /v1/terminal/readers
- "Delete a reader?" -> DELETE /v1/terminal/readers/{reader}
- "Get reader details?" -> GET /v1/terminal/readers/{reader}
- "Create a cancel_action?" -> POST /v1/terminal/readers/{reader}/cancel_action
- "Create a collect_input?" -> POST /v1/terminal/readers/{reader}/collect_inputs
- "Create a collect_payment_method?" -> POST /v1/terminal/readers/{reader}/collect_payment_method
- "Create a confirm_payment_intent?" -> POST /v1/terminal/readers/{reader}/confirm_payment_intent
- "Create a process_payment_intent?" -> POST /v1/terminal/readers/{reader}/process_payment_intent
- "Create a process_setup_intent?" -> POST /v1/terminal/readers/{reader}/process_setup_intent
- "Create a refund_payment?" -> POST /v1/terminal/readers/{reader}/refund_payment
- "Create a set_reader_display?" -> POST /v1/terminal/readers/{reader}/set_reader_display
- "Create a refund?" -> POST /v1/terminal/refunds
- "Create a confirmation_token?" -> POST /v1/test_helpers/confirmation_tokens
- "Create a fund_cash_balance?" -> POST /v1/test_helpers/customers/{customer}/fund_cash_balance
- "Create a authorization?" -> POST /v1/test_helpers/issuing/authorizations
- "Create a capture?" -> POST /v1/test_helpers/issuing/authorizations/{authorization}/capture
- "Create a expire?" -> POST /v1/test_helpers/issuing/authorizations/{authorization}/expire
- "Create a finalize_amount?" -> POST /v1/test_helpers/issuing/authorizations/{authorization}/finalize_amount
- "Create a respond?" -> POST /v1/test_helpers/issuing/authorizations/{authorization}/fraud_challenges/respond
- "Create a increment?" -> POST /v1/test_helpers/issuing/authorizations/{authorization}/increment
- "Create a reverse?" -> POST /v1/test_helpers/issuing/authorizations/{authorization}/reverse
- "Create a deliver?" -> POST /v1/test_helpers/issuing/cards/{card}/shipping/deliver
- "Create a fail?" -> POST /v1/test_helpers/issuing/cards/{card}/shipping/fail
- "Create a return?" -> POST /v1/test_helpers/issuing/cards/{card}/shipping/return
- "Create a ship?" -> POST /v1/test_helpers/issuing/cards/{card}/shipping/ship
- "Create a submit?" -> POST /v1/test_helpers/issuing/cards/{card}/shipping/submit
- "Create a activate?" -> POST /v1/test_helpers/issuing/personalization_designs/{personalization_design}/activate
- "Create a deactivate?" -> POST /v1/test_helpers/issuing/personalization_designs/{personalization_design}/deactivate
- "Create a reject?" -> POST /v1/test_helpers/issuing/personalization_designs/{personalization_design}/reject
- "Create a settlement?" -> POST /v1/test_helpers/issuing/settlements
- "Create a complete?" -> POST /v1/test_helpers/issuing/settlements/{settlement}/complete
- "Create a create_force_capture?" -> POST /v1/test_helpers/issuing/transactions/create_force_capture
- "Create a create_unlinked_refund?" -> POST /v1/test_helpers/issuing/transactions/create_unlinked_refund
- "Create a refund?" -> POST /v1/test_helpers/issuing/transactions/{transaction}/refund
- "Create a expire?" -> POST /v1/test_helpers/refunds/{refund}/expire
- "Create a present_payment_method?" -> POST /v1/test_helpers/terminal/readers/{reader}/present_payment_method
- "Create a succeed_input_collection?" -> POST /v1/test_helpers/terminal/readers/{reader}/succeed_input_collection
- "Create a timeout_input_collection?" -> POST /v1/test_helpers/terminal/readers/{reader}/timeout_input_collection
- "List all test_clocks?" -> GET /v1/test_helpers/test_clocks
- "Create a test_clock?" -> POST /v1/test_helpers/test_clocks
- "Delete a test_clock?" -> DELETE /v1/test_helpers/test_clocks/{test_clock}
- "Get test_clock details?" -> GET /v1/test_helpers/test_clocks/{test_clock}
- "Create a advance?" -> POST /v1/test_helpers/test_clocks/{test_clock}/advance
- "Create a fail?" -> POST /v1/test_helpers/treasury/inbound_transfers/{id}/fail
- "Create a return?" -> POST /v1/test_helpers/treasury/inbound_transfers/{id}/return
- "Create a succeed?" -> POST /v1/test_helpers/treasury/inbound_transfers/{id}/succeed
- "Create a fail?" -> POST /v1/test_helpers/treasury/outbound_payments/{id}/fail
- "Create a post?" -> POST /v1/test_helpers/treasury/outbound_payments/{id}/post
- "Create a return?" -> POST /v1/test_helpers/treasury/outbound_payments/{id}/return
- "Create a fail?" -> POST /v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/fail
- "Create a post?" -> POST /v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/post
- "Create a return?" -> POST /v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/return
- "Create a received_credit?" -> POST /v1/test_helpers/treasury/received_credits
- "Create a received_debit?" -> POST /v1/test_helpers/treasury/received_debits
- "Create a token?" -> POST /v1/tokens
- "Get token details?" -> GET /v1/tokens/{token}
- "List all topups?" -> GET /v1/topups
- "Create a topup?" -> POST /v1/topups
- "Get topup details?" -> GET /v1/topups/{topup}
- "Create a cancel?" -> POST /v1/topups/{topup}/cancel
- "List all transfers?" -> GET /v1/transfers
- "Create a transfer?" -> POST /v1/transfers
- "List all reversals?" -> GET /v1/transfers/{id}/reversals
- "Create a reversal?" -> POST /v1/transfers/{id}/reversals
- "Get transfer details?" -> GET /v1/transfers/{transfer}
- "Get reversal details?" -> GET /v1/transfers/{transfer}/reversals/{id}
- "List all credit_reversals?" -> GET /v1/treasury/credit_reversals
- "Create a credit_reversal?" -> POST /v1/treasury/credit_reversals
- "Get credit_reversal details?" -> GET /v1/treasury/credit_reversals/{credit_reversal}
- "List all debit_reversals?" -> GET /v1/treasury/debit_reversals
- "Create a debit_reversal?" -> POST /v1/treasury/debit_reversals
- "Get debit_reversal details?" -> GET /v1/treasury/debit_reversals/{debit_reversal}
- "List all financial_accounts?" -> GET /v1/treasury/financial_accounts
- "Create a financial_account?" -> POST /v1/treasury/financial_accounts
- "Get financial_account details?" -> GET /v1/treasury/financial_accounts/{financial_account}
- "Create a close?" -> POST /v1/treasury/financial_accounts/{financial_account}/close
- "List all features?" -> GET /v1/treasury/financial_accounts/{financial_account}/features
- "Create a feature?" -> POST /v1/treasury/financial_accounts/{financial_account}/features
- "List all inbound_transfers?" -> GET /v1/treasury/inbound_transfers
- "Create a inbound_transfer?" -> POST /v1/treasury/inbound_transfers
- "Get inbound_transfer details?" -> GET /v1/treasury/inbound_transfers/{id}
- "Create a cancel?" -> POST /v1/treasury/inbound_transfers/{inbound_transfer}/cancel
- "List all outbound_payments?" -> GET /v1/treasury/outbound_payments
- "Create a outbound_payment?" -> POST /v1/treasury/outbound_payments
- "Get outbound_payment details?" -> GET /v1/treasury/outbound_payments/{id}
- "Create a cancel?" -> POST /v1/treasury/outbound_payments/{id}/cancel
- "List all outbound_transfers?" -> GET /v1/treasury/outbound_transfers
- "Create a outbound_transfer?" -> POST /v1/treasury/outbound_transfers
- "Get outbound_transfer details?" -> GET /v1/treasury/outbound_transfers/{outbound_transfer}
- "Create a cancel?" -> POST /v1/treasury/outbound_transfers/{outbound_transfer}/cancel
- "List all received_credits?" -> GET /v1/treasury/received_credits
- "Get received_credit details?" -> GET /v1/treasury/received_credits/{id}
- "List all received_debits?" -> GET /v1/treasury/received_debits
- "Get received_debit details?" -> GET /v1/treasury/received_debits/{id}
- "List all transaction_entries?" -> GET /v1/treasury/transaction_entries
- "Get transaction_entry details?" -> GET /v1/treasury/transaction_entries/{id}
- "List all transactions?" -> GET /v1/treasury/transactions
- "Get transaction details?" -> GET /v1/treasury/transactions/{id}
- "List all webhook_endpoints?" -> GET /v1/webhook_endpoints
- "Create a webhook_endpoint?" -> POST /v1/webhook_endpoints
- "Delete a webhook_endpoint?" -> DELETE /v1/webhook_endpoints/{webhook_endpoint}
- "Get webhook_endpoint details?" -> GET /v1/webhook_endpoints/{webhook_endpoint}
- "How to authenticate?" -> See Auth section
## Response Tips
- Check response schemas in references/api-spec.lap for field details
- List endpoints may support pagination; check for limit, offset, or cursor params
- Create/update endpoints typically return the created/updated object
## References
- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas
> Generated from the official API spec by [LAP](https://lap.sh)