API Documentation
Endpoints
- Analytics
- Auth
- System
- User
- Workspace
- GETGet workspaces
- POSTCreate workspace
- GETGet workspace
- DELDelete workspace
- PATCHUpdate workspace
- GETGet all invoices that belong to the workspace
- GETReturn the generated invoice PDF
- GETGet workspace members
- POSTInvite workspace member
- POSTJoin to a workspace
- DELRemove workspace member
- GETGet workspace subscription
- DELCancel workspace subscription
- GET
- Domain
- Link
- QR Code
Get workspaces
Returns the list of workspaces in the system.
curl --request GET \
--url https://api.ziplink.click/v1/workspaces \
--header 'Authorization: Bearer <token>'
{
"items": [
{
"billing_address_city": "cus_JgZ1z1z1z1z1z1",
"billing_address_country": "cus_JgZ1z1z1z1z1z1",
"billing_address_line_1": "cus_JgZ1z1z1z1z1z1",
"billing_address_line_2": "cus_JgZ1z1z1z1z1z1",
"billing_address_postal_code": "cus_JgZ1z1z1z1z1z1",
"billing_address_state": "cus_JgZ1z1z1z1z1z1",
"created_at": "2023-11-07T05:31:56Z",
"email": "[email protected]",
"id": "ab782971-4d79-47ab-8685-77cf5a34b2bb",
"name": "ACME Inc.",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"pagination": {
"page_number": 5,
"page_size": 100,
"total": 1000
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
Number of resources to skip.
x >= 0
Number of resources to return.
1 <= x <= 1000
Response
A workspace in the system.
Date when the workspace was created.
Unique identifier of the workspace.
"ab782971-4d79-47ab-8685-77cf5a34b2bb"
Name of the workspace.
1 - 120
"ACME Inc."
Date when the workspace was updated.
City name for billing purposes (in English).
1 - 168
"cus_JgZ1z1z1z1z1z1"
Country name for billing purposes (in English).
2
"cus_JgZ1z1z1z1z1z1"
Address line 1 for billing purposes.
1 - 255
"cus_JgZ1z1z1z1z1z1"
Address line 2 for billing purposes.
1 - 255
"cus_JgZ1z1z1z1z1z1"
Postal code for billing purposes.
1 - 16
"cus_JgZ1z1z1z1z1z1"
State/Province name for billing purposes (in English).
1 - 16
"cus_JgZ1z1z1z1z1z1"
curl --request GET \
--url https://api.ziplink.click/v1/workspaces \
--header 'Authorization: Bearer <token>'
{
"items": [
{
"billing_address_city": "cus_JgZ1z1z1z1z1z1",
"billing_address_country": "cus_JgZ1z1z1z1z1z1",
"billing_address_line_1": "cus_JgZ1z1z1z1z1z1",
"billing_address_line_2": "cus_JgZ1z1z1z1z1z1",
"billing_address_postal_code": "cus_JgZ1z1z1z1z1z1",
"billing_address_state": "cus_JgZ1z1z1z1z1z1",
"created_at": "2023-11-07T05:31:56Z",
"email": "[email protected]",
"id": "ab782971-4d79-47ab-8685-77cf5a34b2bb",
"name": "ACME Inc.",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"pagination": {
"page_number": 5,
"page_size": 100,
"total": 1000
}
}