List contacts, most recent activity first

GET

/api/v1/workspaces/{workspace}/contacts

package main

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

func main() {

  url := "https://reputecast.example.com/api/v1/workspaces/acme-newsletter/contacts?tier=active&mailbox=gmail&consent=double&check=valid&band=cold&sort=activity&paid=with_access&phone=yes&page=1&pageSize=10"

  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/contacts?tier=active&mailbox=gmail&consent=double&check=valid&band=cold&sort=activity&paid=with_access&phone=yes&page=1&pageSize=10';
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/contacts?tier=active&mailbox=gmail&consent=double&check=valid&band=cold&sort=activity&paid=with_access&phone=yes&page=1&pageSize=10' \
  --header 'Authorization: Bearer <token>'

Permission: subscribers:view

Authorizations

bearer

Parameters

Path Parameters

workspace

required

Workspace slug

string

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

Workspace slug

Query Parameters

Email, name or tag

string

<= 200 characters

Email, name or tag

list

List id

string

List id

tier

string

Allowed values: active cooling at_risk sunset ""

mailbox

string

Allowed values: gmail outlook yahoo icloud other ""

consent

string

Allowed values: double single pending ""

source

string

<= 80 characters

tag

string

<= 80 characters

segment

Segment id

string

Segment id

joinedAfter

string

<= 10 characters

check

The latest address check’s result

string

Allowed values: valid invalid risky unknown never ""

The latest address check’s result

language

A workspace language’s code (es also matches es-MX), none or not_offered

string

<= 16 characters

A workspace language’s code (es also matches es-MX), none or not_offered

band

string

Allowed values: cold warm hot none ""

scoreFrom

string

<= 3 characters

scoreTo

string

<= 3 characters

growthSource

string

<= 200 characters

utmSource

string

<= 200 characters

utmMedium

string

<= 200 characters

utmCampaign

string

<= 200 characters

referringDomain

string

<= 255 characters

sort

string

Allowed values: activity score ""

signedIn

Only contacts who signed in to the website

boolean

Only contacts who signed in to the website

paid

string

Allowed values: with_access trialing past_due complimentary gift ended free ""

paidTier

With paid=with_access: a tier’s id, for that tier and above

string

With paid=with_access: a tier’s id, for that tier and above

pushSubscribed

Only contacts with a linked push subscription

boolean

Only contacts with a linked push subscription

whatsAppConsent

Only contacts with WhatsApp consent on a list

boolean

Only contacts with WhatsApp consent on a list

bought

Only contacts who bought a product: any, or the product’s id

string

<= 40 characters

Only contacts who bought a product: any, or the product’s id

storeCustomer

A store’s id, or any

string

<= 36 characters

A store’s id, or any

spentFrom

Total spent in the stores, at least

string

<= 12 characters

Total spent in the stores, at least

spentTo

Total spent in the stores, at most

string

<= 12 characters

Total spent in the stores, at most

phone

Yes: contacts with a phone number; no: without one

string

Allowed values: yes no ""

Yes: contacts with a phone number; no: without one

phoneCountry

The phone number’s country (GB)

string

<= 2 characters

The phone number’s country (GB)

smsConsent

Any: SMS consent on some list; none: on none; or a list id

string

<= 40 characters

Any: SMS consent on some list; none: on none; or a list id

page

integer format: int64

default: 1 >= 1

pageSize

integer format: int64

default: 10 >= 1 <= 100

Responses

200

application/json

object

items

required

Array<object>

object

consent

required

string

Allowed values: double single pending

email

required

string

required

string

joinedAt

required

string format: date-time

lastOpenAt

string format: date-time

lastOpenMachine

required

The last open was a machine open (Apple Mail Privacy Protection)

boolean

lists

required

Array<string>

mailboxLabel

required

Outlook, or Other · Google Workspace

string

mailboxProvider

required

string

name

required

string

paid

object

endedAt

string format: date-time

memberId

required

string

status

required

string

Allowed values: trialing active past_due complimentary gift ended

tier

required

The tier’s short name (Insider)

string

phone

string

score

integer format: int64

scoreBand

string

Allowed values: cold warm hot

source

required

string

sourceLabel

required

string

suppressed

required

boolean

tier

required

string

Allowed values: active cooling at_risk sunset

page

required

integer format: int64

pageSize

required

integer format: int64

total

required

integer format: int64

Example

{
  "items": [
    {
      "consent": "double",
      "paid": {
        "status": "trialing"
      },
      "scoreBand": "cold",
      "tier": "active"
    }
  ]
}

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