Skip to content

Every sending adapter this build can connect, with capabilities, pricing and terms

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

Permission: providers:view

workspace
required

Workspace slug

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

Workspace slug

OK

Media typeapplication/json
object
builtin
required
Array<object>
object
adapter
required
string
bulkAllowed
required
boolean
chips
required
Array<object>
object
kind
required
string
Allowed values: yes partial no
label
required
string
connected
required
integer format: int64
dedicatedIps
required
boolean
kind
required
string
Allowed values: api smtp self_hosted community
name
required
string
pricing
required
string
recommended
required
boolean
short
required
string
terms
required
string
termsTone
required
string
Allowed values: ok warn neutral
webhooks
required
boolean
canConnect
required
boolean
community
required
Array<object>
object
adapter
required
string
configure
required
boolean
id
required
string
maintainer
required
string
name
required
string
reason
string
summary
required
string
version
required
string
helpers
required
Array<string>
open
required
Array<object>
object
adapter
required
string
id
required
string
name
required
string
step
required
string
updatedAt
required
string format: date-time

Example

{
"builtin": [
{
"chips": [
{
"kind": "yes"
}
],
"kind": "api",
"termsTone": "ok"
}
]
}

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