share_api_endpoint
Create an endpoint's shareable link and return it. With no other arguments the link stays restricted: workspace members can open it (they sign in), which is enough for a PR or an internal message. Only when the user asks to share it outside the workspace: set link_access to viewer (anyone with the link can read) or commenter (Team plan; commenting asks for sign-in), or invite people by email (they get an email and sign in with that address). restricted turns the public link off; the URL stays the same. The page is read-only and always hides credentials and secrets.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| path | No | Route path as written in the code, e.g. /v1/charges/:id or /v1/charges/{id}. | |
| invite | No | People to invite by email (at most 10). Each gets an email. | |
| method | No | HTTP method of the route, e.g. POST. Use with path instead of endpoint_id. | |
| endpoint_id | No | Id of the endpoint. Alternative to method + path. | |
| link_access | No | Who can open it with just the link. Omit to keep the current setting (restricted for a new share). | |
| collection_id | Yes | Id from list_api_collections. |