List your domains
Get the list of domains shared in the current workspace.
Authorizations:
query Parameters
| workspace | string <string> Example: workspace=1646752269439338932 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. |
Responses
Response samples
- 200
- 400
{- "code": 0,
- "message": "success",
- "data": [
- {
- "id": "1639562002248499321",
- "domainName": "demo.xxx.com",
- "rootDomainName": "demo.xxx.com",
- "subDomain": "demo",
- "actualDomainName": "demo.xxx.com",
- "active": true,
- "type": 0,
- "dnsType": "CNAME",
- "dnsValue": "xxx.com",
- "dnsCorrect": true,
- "httpsRequested": true,
- "createdAt": "2023-01-01 00:00:00",
- "updatedAt": "2023-01-01 00:00:00"
}
]
}List links
Get a list of links.
Authorizations:
query Parameters
| page required | integer <int64> Example: page=1 Current page. |
| limit required | integer <int64> [ 1 .. 100 ] Example: limit=10 How many short links to load. |
| sort | string <string> Example: sort=id desc,name Sorting criteria to apply to your short links collection. |
| domainId required | string <string> Example: domainId=1646752269439338931 Filter short links which refer to a specific branded domain id. |
| workspace | string <string> Example: workspace=1646752269439338932 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 | string <string> Example: filter=xxx.com Filter short links according to title or link. |
| tags | string <string> Example: tags=tag1,tag2,tag3 Filter short links according to tags. |
Responses
Response samples
- 200
- 400
{- "code": 0,
- "message": "success",
- "data": [
- {
- "id": "1639562002248499320",
- "workspaceId": "1639562002248499322",
- "domainId": "1639562002248499321",
- "domainName": "www.xxxx.com",
- "title": "demo",
- "path": "demo01",
- "file": "xxxx.com/xxx",
- "recordType": "301",
- "utm": {
- "source": "xxx"
}, - "tags": [
- "tag1",
- "tag2"
], - "createdAt": "2023-01-01 00:00:00",
- "updatedAt": "2023-01-01 00:00:00"
}
]
}Create a new link
Create a new link.
Authorizations:
query Parameters
| workspace | string <string> Example: workspace=1646752269439338932 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. |
Request Body schema: application/json
| domain | string A reference to the Domain resource for this short link. Specify either domain id or domain fullName. If not specified, a default domain is used |
| title | string A title you assign to the branded short link in order to remember what's behind it |
| destination required | string The destination URL you want your branded short link to point to |
| path | string The keyword portion of your short link. If not specified, will be autogenerated |
| utm | object UTM params |
| tags | Array of strings Unique identifier of the Tag resource. |
Responses
Request samples
- Payload
{- "domain": "1646752269439338932",
- "title": "demo",
- "path": "demo01",
- "utm": {
- "source": "xxx"
}, - "tags": [
- "tag1",
- "tag2"
]
}Response samples
- 200
- 400
{- "code": 0,
- "message": "success",
- "data": {
- "id": "1639562002248499320",
- "workspaceId": "1639562002248499322",
- "domainId": "1639562002248499321",
- "domainName": "www.xxxx.com",
- "title": "demo",
- "path": "demo01",
- "file": "xxxx.com/xxx",
- "recordType": "301",
- "utm": {
- "source": "xxx"
}, - "tags": [
- "tag1",
- "tag2"
], - "createdAt": "2023-01-01 00:00:00",
- "updatedAt": "2023-01-01 00:00:00"
}
}Get a link
Get details about a specific link.
Authorizations:
path Parameters
| id required | string <string> Example: 1639562002248499321 Unique identifier of the short link you want to get details for. |
query Parameters
| workspace | string <string> Example: workspace=1646752269439338932 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. |
Responses
Response samples
- 200
- 400
{- "code": 0,
- "message": "success",
- "data": {
- "id": "1639562002248499320",
- "workspaceId": "1639562002248499322",
- "domainId": "1639562002248499321",
- "domainName": "www.xxxx.com",
- "title": "demo",
- "path": "demo01",
- "file": "xxxx.com/xxx",
- "recordType": "301",
- "utm": {
- "source": "xxx"
}, - "tags": [
- "tag1",
- "tag2"
], - "createdAt": "2023-01-01 00:00:00",
- "updatedAt": "2023-01-01 00:00:00"
}
}Update a link
Update a link.
Authorizations:
path Parameters
| id required | string <string> Example: 1639562002248499321 Unique identifier of the short link you want to update. |
query Parameters
| workspace | string <string> Example: workspace=1646752269439338932 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. |
Request Body schema: application/json
| domain | string A reference to the Domain resource for this short link. Specify either domain id or domain fullName. If not specified, will not be updated |
| title | string A title you assign to the short link in order to remember what's behind it. If not specified, will not be updated |
| destination | string The destination URL you want your short link to point to. If not specified, will not be updated |
| path | string The keyword portion of your branded short link. If not specified, will not be updated |
| utm | object UTM params |
| tags | Array of strings Unique identifier of the Tag resource. If not specified, will not be updated |
Responses
Request samples
- Payload
{- "domain": "1646752269439338932",
- "title": "demo",
- "path": "demo01",
- "utm": {
- "source": "xxx"
}, - "tags": [
- "tag1",
- "tag2"
]
}Response samples
- 200
- 400
{- "code": 0,
- "message": "success",
- "data": null
}Delete a link
Delete a new link.
Authorizations:
path Parameters
| id required | string <string> Example: 1639562002248499321 Unique identifier of the short link you want to delete. |
query Parameters
| workspace | string <string> Example: workspace=1646752269439338932 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. |
Responses
Response samples
- 200
- 400
{- "code": 0,
- "message": "success",
- "data": null
}Update the tags
Update the tags of a link.
Authorizations:
path Parameters
| id required | string <string> Example: 1639562002248499321 Unique identifier of the short link you want to update tags. |
query Parameters
| workspace | string <string> Example: workspace=1646752269439338932 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. |
Request Body schema: application/json
| tags | Array of strings Unique identifier of the Tag resource. |
Responses
Request samples
- Payload
{- "tags": [
- "tag1",
- "tag2"
]
}Response samples
- 200
- 400
{- "code": 0,
- "message": "success",
- "data": null
}List tags
Get a list of tags.
Authorizations:
query Parameters
| workspace | string <string> Example: workspace=1646752269439338932 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. |
Responses
Response samples
- 200
{- "code": 0,
- "message": "success",
- "data": [
- {
- "slug": "tag1",
- "name": "tag1",
- "count": 1
}
]
}Response samples
- 200
- 400
{- "code": 0,
- "message": "success",
- "data": {
- "id": "1639562002248499320",
- "name": "Bob",
- "defaultWorkspaceId": "1639562002248499322",
- "timezone": "Singapore Standard Time",
- "language": "en",
- "emailVerified": true,
- "emailVerifiedAt": "2023-01-01 00:00:00",
- "createdAt": "2023-01-01 00:00:00",
- "updatedAt": "2023-01-01 00:00:00"
}
}