GET
/
v1
/
workspaces
/
{workspace_id}
curl --request GET \
  --url https://api.ziplink.click/v1/workspaces/{workspace_id} \
  --header 'Authorization: Bearer <token>'
{
  "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"
}

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"

Response

200
application/json
OK

A workspace in the system.

​
created_at
string
required

Date when the workspace was created.

​
email
string
required

Email address of the workspace.

Required string length: 6 - 254
Example:

"[email protected]"

​
id
string
required

Unique identifier of the workspace.

Example:

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

​
name
string
required

Name of the workspace.

Required string length: 1 - 120
Example:

"ACME Inc."

​
updated_at
string | null
required

Date when the workspace was updated.

​
billing_address_city
string

City name for billing purposes (in English).

Required string length: 1 - 168
Example:

"cus_JgZ1z1z1z1z1z1"

​
billing_address_country
string

Country name for billing purposes (in English).

Required string length: 2
Example:

"cus_JgZ1z1z1z1z1z1"

​
billing_address_line_1
string

Address line 1 for billing purposes.

Required string length: 1 - 255
Example:

"cus_JgZ1z1z1z1z1z1"

​
billing_address_line_2
string

Address line 2 for billing purposes.

Required string length: 1 - 255
Example:

"cus_JgZ1z1z1z1z1z1"

​
billing_address_postal_code
string

Postal code for billing purposes.

Required string length: 1 - 16
Example:

"cus_JgZ1z1z1z1z1z1"

​
billing_address_state
string

State/Province name for billing purposes (in English).

Required string length: 1 - 16
Example:

"cus_JgZ1z1z1z1z1z1"