Skip to content
ReputeCastReputeCast Docs

WordPress sites: health, forms, post drafts and keys

GET
/api/v1/workspaces/{workspace}/integrations/wordpress
curl --request GET \
  --url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/integrations/wordpress \
  --header 'Authorization: Bearer <token>'

Permission: integrations:view

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
workspace
required

Workspace slug

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

Workspace slug

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
canEditForms
required
boolean
canManage
required
boolean
connectedBy
string
helpers
required
Array<string>
instanceUrl
required
string
latestPlugin
required
string
lists
required
Array<object>
object
contacts
required
integer format: int64
id
required
string
name
required
string
members
required
Array<object>
object
detail
string
id
required
string
name
required
string
reasons
required
Array<object>
object
by
string
calls
integer format: int64
check
object
checkedAt
required
string format: date-time
detail
required
string
ms
integer format: int64
ok
required
boolean
outcome
required
string
Allowed values: answered timeout status blocked unreachable
seconds
number format: double
status
integer format: int64
code
required
string
Allowed values: key_revoked key_expired owner_left key_expiring deliveries_failing calls_failing site_silent
connectionId
string
failed
integer format: int64
host
string
nextAt
string format: date-time
rejected
integer format: int64
retrying
integer format: int64
since
string format: date-time
status
integer format: int32
statusText
string
senders
required
Array<object>
object
detail
string
id
required
string
name
required
string
sites
required
Array<object>
object
categories
required
Array<object>
object
id
required
string
name
required
string
<= 200 characters
slug
required
string
<= 200 characters
connectedAt
required
string format: date-time
connectedBy
string
drafts
required
Array<object>
object
audience
string
campaignId
string
createdAt
required
string format: date-time
notified
string
postUrl
string
publishedAt
string format: date-time
status
required

The campaign’s status (draft, scheduled, sent…)

string
title
required
string
draftsThisWeek
required
integer format: int64
feedUrl
string
firstReportAt
string format: date-time
forms
required
Array<object>
object
allowed
required

The site is one of the form’s allowed domains

boolean
id
required

The form’s uuid, for links

string
kind
required
string
Allowed values: block shortcode widget
missing
required

The site uses a form that no longer exists

boolean
name
required
string
places
required
Array<object>
object
title
required
string
<= 200 characters
url
string
<= 500 characters
publicId
required
string
host
required
string
id
required

The connection’s id

string
items
required
Array<object>
object
available
required
boolean
event
string
key
required
string
kind
required
string
Allowed values: trigger action
missing
string
new
required
boolean
offReason
string
Allowed values: turned_off owner_lacks ""
on
required
boolean
owner
string
permissions
required
Array<string>
sensitive
required
boolean
key
object
createdAt
required
string format: date-time
expiresAt
string format: date-time
graceUntil

A rotated key keeps working until then

string format: date-time
id
required
string
lastUsedAt
string format: date-time
lastUsedClient
string
lastUsedIp
string
masked
required
string
name
required
string
owner
required
object
avatarColor
string
id
string
name
required
string
ownerLeftAt
string format: date-time
ownerStatus
required
string
Allowed values: active deactivated removed
permissions
required

As held: implied view permissions left out

Array<string>
revokedAt
string format: date-time
scope
required
object
all
required
boolean
label
required
string
lists
required
Array<object>
object
id
required
string
name
required
string
senderDomains
required
Array<string>
sensitive
required
Array<string>
status
required
string
Allowed values: active grace revoked expired
languagePlugin
string
lastCheck
object
checkedAt
required
string format: date-time
detail
required
string
ms
integer format: int64
ok
required
boolean
outcome
required
string
Allowed values: answered timeout status blocked unreachable
seconds
number format: double
status
integer format: int64
lastReportAt
string format: date-time
name
string
oldKey
object
createdAt
required
string format: date-time
expiresAt
string format: date-time
graceUntil

A rotated key keeps working until then

string format: date-time
id
required
string
lastUsedAt
string format: date-time
lastUsedClient
string
lastUsedIp
string
masked
required
string
name
required
string
owner
required
object
avatarColor
string
id
string
name
required
string
ownerLeftAt
string format: date-time
ownerStatus
required
string
Allowed values: active deactivated removed
permissions
required

As held: implied view permissions left out

Array<string>
revokedAt
string format: date-time
scope
required
object
all
required
boolean
label
required
string
lists
required
Array<object>
object
id
required
string
name
required
string
senderDomains
required
Array<string>
sensitive
required
Array<string>
status
required
string
Allowed values: active grace revoked expired
phpVersion
string
pluginVersion
string
reasons
required
Array<object>
object
by
string
calls
integer format: int64
check
object
checkedAt
required
string format: date-time
detail
required
string
ms
integer format: int64
ok
required
boolean
outcome
required
string
Allowed values: answered timeout status blocked unreachable
seconds
number format: double
status
integer format: int64
code
required
string
Allowed values: key_revoked key_expired owner_left key_expiring deliveries_failing calls_failing site_silent
connectionId
string
failed
integer format: int64
host
string
nextAt
string format: date-time
rejected
integer format: int64
retrying
integer format: int64
since
string format: date-time
status
integer format: int32
statusText
string
rule
required
object
categories
required
Array<object>
object
id
required
string
name
required
string
<= 200 characters
slug
required
string
<= 200 characters
enabled
required
boolean
list
object
contacts
required
integer format: int64
id
required
string
name
required
string
listIds
required
Array<string>
notify
object
detail
string
id
required
string
name
required
string
sender
object
detail
string
id
required
string
name
required
string
set
required

A rule was set up (even if it’s off now)

boolean
template
object
detail
string
id
required
string
name
required
string
signupsRejected
required
boolean
siteUrl
string
status
required
string
Allowed values: waiting connected attention
updateAvailable
required
boolean
woocommerce
object
checkouts
required
boolean
consent
required
boolean
storeId
string
storeName
string
storeStatus
string
Allowed values: connecting importing connected disconnected ""
version
required
string
wordpressVersion
string
status
required
string
Allowed values: not_connected waiting connected attention
templates
required
Array<object>
object
detail
string
id
required
string
name
required
string
updateAvailable
required
boolean

Example 

{
  "reasons": [
    {
      "check": {
        "detail": "Timed out after 10 s",
        "outcome": "answered"
      },
      "code": "key_revoked"
    }
  ],
  "sites": [
    {
      "forms": [
        {
          "kind": "block",
          "places": [
            {
              "title": "Join the beta"
            }
          ],
          "publicId": "frm_8c2e1a"
        }
      ],
      "items": [
        {
          "kind": "trigger",
          "offReason": "turned_off"
        }
      ],
      "key": {
        "masked": "rc_live_5d1e…7b20",
        "ownerStatus": "active",
        "status": "active"
      },
      "lastCheck": {
        "detail": "Timed out after 10 s",
        "outcome": "answered"
      },
      "oldKey": {
        "masked": "rc_live_5d1e…7b20",
        "ownerStatus": "active",
        "status": "active"
      },
      "reasons": [
        {
          "check": {
            "detail": "Timed out after 10 s",
            "outcome": "answered"
          },
          "code": "key_revoked"
        }
      ],
      "status": "waiting",
      "woocommerce": {
        "storeStatus": "connecting"
      }
    }
  ],
  "status": "not_connected"
}

default

Section titled “default”

Error

Media typeapplication/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"
}
Report a problem with this pageReputeCast websiteHostReputeContent licensed under CC BY 4.0