List routing rules

GET

/api/v1/email-routing/rules

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

• Digize

Every routed address at the workspace’s domains and what happens to its mail, with the last 30 days’ count.

Needs the sites:read permission.

Authorizations

• apiKey
• bearer

Responses

200

Done

Media typeapplication/json

Array<object>

object

id

required

string

address

required

string

domain

required

string

action

required

One of:

object

object

type

required

string

Allowed value: forward

to

required

string

object

object

type

required

string

Allowed value: conversations

object

object

type

required

string

Allowed value: worker

worker

required

string

object

object

type

required

string

Allowed value: drop

enabled

required

boolean

managedBy

required

string | null

received

required

number

lastReceivedAt

required

Any of:

string

string format: date-time

null

null

createdAt

required

string format: date-time

Example

[
  {
    "action": {
      "type": "forward"
    }
  }
]

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"
  }
}