All URIs are relative to https://app.linksgpt.com
| Method | HTTP request | Description |
|---|---|---|
| CreateLink | Post /api/v1/links | Create a new link |
| DeleteLink | Delete /api/v1/links/{id} | Delete a link |
| GetLinkById | Get /api/v1/links/{id} | Get a link |
| ListLinks | Get /api/v1/links | List links |
| ListTags | Get /api/v1/links/tags | List tags |
| UpdateLink | Put /api/v1/links/{id} | Update a link |
| UpdateLinkTags | Put /api/v1/links/{id}/tags | Update the tags |
InlineResponse2002 CreateLink(ctx, optional) Create a new link
Create a new link.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *V1LinksApiCreateLinkOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a V1LinksApiCreateLinkOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| body | optional.Interface of V1CreateLinkRequest | ||
| workspace | optional. | Your workspace id, if you do not specify the workspace context, the default workspace (your main workspace) will be used. If apikey is used as the authentication mode, you do not need to set this parameter. |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
InlineResponse2003 DeleteLink(ctx, id, optional) Delete a link
Delete a new link.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | Unique identifier of the short link you want to delete. | |
| optional | *V1LinksApiDeleteLinkOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a V1LinksApiDeleteLinkOpts struct
| Name | Type | Description | Notes |
|---|
workspace | optional.String| Your workspace id, if you do not specify the workspace context, the default workspace (your main workspace) will be used. If apikey is used as the authentication mode, you do not need to set this parameter. |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
InlineResponse2002 GetLinkById(ctx, id, optional) Get a link
Get details about a specific link.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | Unique identifier of the short link you want to get details for. | |
| optional | *V1LinksApiGetLinkByIdOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a V1LinksApiGetLinkByIdOpts struct
| Name | Type | Description | Notes |
|---|
workspace | optional.String| Your workspace id, if you do not specify the workspace context, the default workspace (your main workspace) will be used. If apikey is used as the authentication mode, you do not need to set this parameter. |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
InlineResponse2001 ListLinks(ctx, page, limit, domainId, optional) List links
Get a list of links.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| page | int64 | Current page. | |
| limit | int64 | How many short links to load. | |
| domainId | string | Filter short links which refer to a specific branded domain id. | |
| optional | *V1LinksApiListLinksOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a V1LinksApiListLinksOpts struct
| Name | Type | Description | Notes |
|---|
sort | optional.String| Sorting criteria to apply to your short links collection. | workspace | optional.String| Your workspace id, if you do not specify the workspace context, the default workspace (your main workspace) will be used. If apikey is used as the authentication mode, you do not need to set this parameter. | filter | optional.String| Filter short links according to title or link. | tags | optional.String| Filter short links according to tags. |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
InlineResponse2004 ListTags(ctx, optional) List tags
Get a list of tags.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *V1LinksApiListTagsOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a V1LinksApiListTagsOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| workspace | optional.String | Your workspace id, if you do not specify the workspace context, the default workspace (your main workspace) will be used. If apikey is used as the authentication mode, you do not need to set this parameter. |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
InlineResponse2003 UpdateLink(ctx, id, optional) Update a link
Update a link.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | Unique identifier of the short link you want to update. | |
| optional | *V1LinksApiUpdateLinkOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a V1LinksApiUpdateLinkOpts struct
| Name | Type | Description | Notes |
|---|
body | optional.Interface of V1UpdateLinkRequest| | workspace | optional.| Your workspace id, if you do not specify the workspace context, the default workspace (your main workspace) will be used. If apikey is used as the authentication mode, you do not need to set this parameter. |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
InlineResponse2003 UpdateLinkTags(ctx, id, optional) Update the tags
Update the tags of a link.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | Unique identifier of the short link you want to update tags. | |
| optional | *V1LinksApiUpdateLinkTagsOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a V1LinksApiUpdateLinkTagsOpts struct
| Name | Type | Description | Notes |
|---|
body | optional.Interface of V1ReTagRequest| | workspace | optional.| Your workspace id, if you do not specify the workspace context, the default workspace (your main workspace) will be used. If apikey is used as the authentication mode, you do not need to set this parameter. |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]