Get the workspace's address

GET

/api/v1/workspace/address

curl --request GET \
  --url https://digize.com/api/v1/workspace/address \
  --header 'x-api-key: <x-api-key>'

• Digize

The workspace’s address on yourfreesite.com, .yourfreesite.com: every worker answers under it at ..yourfreesite.com, and its booking pages use the name too.

Needs the settings:read permission.

Authorizations

• apiKey
• bearer

Responses

200

Done

Media typeapplication/json

object

name

required

string

hostname

required

string

domain

required

string

since

required

string format: date-time

dns

required

string

Allowed values: pending ready off

fresh

required

boolean

sites

required

number

bookingBase

required

string

renaming

required

Any of:

object

object

from

required

string

at

required

string format: date-time

by

required

string

null

null

Example

{
  "dns": "pending"
}

400

What was sent isn’t valid (invalid).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

401

No key, or one that’s unknown, off or expired.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

403

The key doesn’t have the permission this needs.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

404

Nothing has that id (not_found).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

429

Over the rate limit; see retry-after.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}