Seed mailboxes (passwords and tokens are never returned)

GET

/api/v1/workspaces/{workspace}/placement/seeds

package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "https://reputecast.example.com/api/v1/workspaces/acme-newsletter/placement/seeds"

  req, _ := http.NewRequest("GET", url, nil)

  req.Header.Add("Authorization", "Bearer <token>")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

const url = 'https://reputecast.example.com/api/v1/workspaces/acme-newsletter/placement/seeds';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/placement/seeds \
  --header 'Authorization: Bearer <token>'

Permission: deliverability:view

Authorizations

bearer

Parameters

Path Parameters

workspace

required

Workspace slug

string

/^[a-z0-9][a-z0-9-]{1,62}$/

Workspace slug

Responses

200

application/json

object

attention

required

Seeds whose sign-in failed or expired

integer format: int64

canManage

required

boolean

canRun

required

boolean

connected

required

integer format: int64

deleteAfter

required

string

Allowed values: 24h finished never

manageHelpers

required

Array<string>

oauthGoogle

required

boolean

oauthMicrosoft

required

boolean

providers

required

Array<object>

object

company

required

Who runs the mailboxes (Apple for iCloud)

string

host

required

string

imapHelp

string

inboxName

required

string

key

required

string

name

required

string

oauth

string

Allowed values: google microsoft ""

password

required

string

passwordHelp

string

port

required

integer format: int64

spamName

required

string

tabs

required

Array<string>

usernameLabel

required

string

redirectUri

required

string

runHelpers

required

Array<string>

seeds

required

Array<object>

object

addedAt

required

string format: date-time

addedBy

required

string

auth

required

string

Allowed values: password oauth

checkedAt

string format: date-time

company

required

string

email

required

string

folders

required

Array<object>

object

label

required

string

name

required

string

role

required

string

Allowed values: inbox tab spam

host

string

required

string

lastTest

string

lastTestId

string

lastUsedAt

string format: date-time

passwordLabel

required

string

port

integer format: int64

provider

required

string

Allowed values: gmail google_workspace outlook microsoft_365 yahoo aol icloud gmx webde

providerName

required

string

status

required

string

Allowed values: connected expired failed unchecked

statusAt

string format: date-time

username

string

Example

{
  "deleteAfter": "24h",
  "providers": [
    {
      "oauth": "google"
    }
  ],
  "seeds": [
    {
      "auth": "password",
      "folders": [
        {
          "role": "inbox"
        }
      ],
      "provider": "gmail",
      "status": "connected"
    }
  ]
}

default

Error

application/problem+json

object

code

Stable error code, e.g. permission_denied

string

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

Array<object>

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

helpers

Members who hold the missing permission

Array<string>

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

meta

object

key

additional properties

permission

The missing permission key

string

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

Example

{
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}