List contacts
const url = 'https://api.sendwing.app/api/organizations/example/contacts?limit=50&status=subscribed';const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};
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://api.sendwing.app/api/organizations/example/contacts?limit=50&status=subscribed' \ --header 'x-api-key: <x-api-key>'Newest first. Filter by email or externalId to find one contact: each is unique in a workspace, and email is matched ignoring case. search matches part of an email or name.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The workspace, like org_…. An OAuth access token works in the one the member picked when connecting, which GET /me returns.
Query Parameters
Section titled “Query Parameters”How many items a page holds
The nextCursor of the previous page
Only contacts with this status
The contact with this email, ignoring case
The contact with this external ID
Only contacts with this tag, by ID
Contacts whose email or name contains this, ignoring case
Responses
Section titled “Responses”A page of contacts
object
object
Like con_…
The contact’s ID in your own system
Whether Sendwing emails the contact. pending waits for double opt-in; bounced and complained are set by delivery feedback and are never emailed again.
Where the contact came from, like api, import, form or zapier
A BCP 47 language tag, like en or pt-BR
An IANA time zone, like Europe/Berlin
An ISO 3166-1 alpha-2 code, like DE
YYYY-MM-DD, or --MM-DD when the year isn’t known
Custom property values, by property key
object
object
object
Pass as cursor to get the next page; null on the last page
Example
{ "data": [ { "status": "subscribed", "mailingLists": [ { "status": "subscribed" } ] } ]}The request isn’t valid; issues lists each problem
object
What went wrong, in words you can show people
For a 400: each invalid field, by its path in the request, like events.0.name
object
For a 5xx: quote it when contacting support
Example generated
{ "error": "example", "issues": [ { "path": "example", "message": "example" } ], "requestId": "example"}The API key or access token is missing, invalid or expired
object
What went wrong, in words you can show people
For a 400: each invalid field, by its path in the request, like events.0.name
object
For a 5xx: quote it when contacting support
Example generated
{ "error": "example", "issues": [ { "path": "example", "message": "example" } ], "requestId": "example"}The API key’s permissions, or the app’s scopes and the member’s role, don’t allow this
object
What went wrong, in words you can show people
For a 400: each invalid field, by its path in the request, like events.0.name
object
For a 5xx: quote it when contacting support
Example generated
{ "error": "example", "issues": [ { "path": "example", "message": "example" } ], "requestId": "example"}Too many requests; wait for the seconds in Retry-After
object
What went wrong, in words you can show people
For a 400: each invalid field, by its path in the request, like events.0.name
object
For a 5xx: quote it when contacting support
Example generated
{ "error": "example", "issues": [ { "path": "example", "message": "example" } ], "requestId": "example"}