GET
/
v1
/
workspaces
/
{workspace_id}
/
links
curl --request GET \
  --url https://api.ziplink.click/v1/workspaces/{workspace_id}/links \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "alias": "conf2024",
      "created_at": "2023-11-07T05:31:56Z",
      "domain_id": "ab782971-4d79-47ab-8685-77cf5a34b2bb",
      "expired_redirect_url": "https://example.com/2024-conference-dubai",
      "expires_at": "2023-11-07T05:31:56Z",
      "has_analytics": false,
      "has_qr_code": false,
      "id": "ab782971-4d79-47ab-8685-77cf5a34b2bb",
      "is_reported": false,
      "qr_code_id": "ab782971-4d79-47ab-8685-77cf5a34b2bb",
      "qr_code_url": "https://example.com/2024-conference-dubai",
      "short_url": "https://zipl.ink/conf2024",
      "status": "active",
      "title": "Marketing homepage",
      "updated_at": "2023-11-07T05:31:56Z",
      "url": "https://example.com/2024-conference-dubai",
      "workspace_id": "ab782971-4d79-47ab-8685-77cf5a34b2bb"
    }
  ],
  "pagination": {
    "page_number": 5,
    "page_size": 100,
    "total": 1000
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
workspace_id
string
required

ID of the workspace.

Example:

"ab782971-4d79-47ab-8685-77cf5a34b2bb"

Query Parameters

​
title
string

Name of the link.

Example:

"Marketing homepage"

​
domain-id
string

ID of the domain.

Example:

"ab782971-4d79-47ab-8685-77cf5a34b2bb"

​
status
enum<string>

Status of the link.

Available options:
active,
deleted
Example:

"active"

​
expires-after
string

Optional expiration date and time.

​
expires-before
string

Optional expiration date and time.

​
has-analytics
boolean

Whether analytics are enabled for the link or not.

​
has-qr-code
boolean

Whether QR code is enabled for the link or not.

​
created-before
string

The creation date that will be used to query results until.

​
created-after
string

The creation date that will be used to query results from.

​
offset
integer
default:0

Number of resources to skip.

Required range: x >= 0
​
limit
integer
default:100

Number of resources to return.

Required range: 1 <= x <= 1000

Response

200
application/json
OK
​
items
object[]
required

A link in the system.

​
pagination
object
required