List a form's external recipients

GET

/api/v1/forms/{id}/recipients

curl --request GET \
  --url https://api.deploybase.eu/api/v1/api/v1/forms/example/recipients \
  --header 'Authorization: <Authorization>'

Returns every non-member address linked to the form, with its verification status.

Authorizations

• BearerAuth

Parameters

Path Parameters

id

required

string

Form ID

Responses

200

OK

Media type application/json

object

data

meta

object

request_id

string

timestamp

string

trace_id

string

data

object

recipients

Array<object>

object

created_at

string

email

string

id

string

status

Status is models.FormExternalRecipient.Status(): pending | verified | unsubscribed | bounced | complained. The last two arrived with DEP-332 — an existing client that switches on the first three must treat anything else as “not receiving”, which is what they mean.

string

verified_at

string

total

integer

Example ^generated

{
  "data": {
    "recipients": [
      {
        "created_at": "example",
        "email": "example",
        "id": "example",
        "status": "example",
        "verified_at": "example"
      }
    ],
    "total": 1
  },
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

401

Unauthorized

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

403

Forbidden

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

404

Not Found

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}