HomeGuidesAPI Reference
API Reference
  1. SS Public API
  2. ContactListContacts

Get Opt-Outs

get
https://{host}/v2/contacts/optouts

Gets all contacts who have opted out of receiving survey invitations from your account, with paging. Pages default to 100 opt-outs and can be set from 10 to 100.

This only applies to contacts in the account linked to the API key and not contacts in sub-accounts

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int32

The 1-based page number

int32

The number of results you want up to 100

sort_by
array of strings

Optional list of properties that you want to sort by

sort_by
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Response

Updated 2 days ago

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json

Updated 2 days ago