List contacts
const url = 'https://api.sendtruss.com/v1/workspaces/example/contacts?status=subscribed';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://api.sendtruss.com/v1/workspaces/example/contacts?status=subscribed' \ --header 'Authorization: Bearer <token>'Newest first, 50 to a page.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The workspace: our id, or ref: plus your reference for it, such as ref:cust_4821. A reference is letters, digits, ., _ and -, up to 128 characters, and needs no URL encoding.
Query Parameters
Section titled “Query Parameters”Only contacts whose email address contains this text.
Only contacts in this marketing state.
Only contacts with the tag that has this key.
Responses
Section titled “Responses”Paginated set of ContactResource
object
object
The marketing state: pending until you send consent, then subscribed or unsubscribed.
Marketing consent and when it was given or withdrawn, with who gave it: consented_by_key is the id of the API key that sent the latest accepted subscribed. Null until you send consent.
object
When the person agreed to open tracking, or null.
Values by attribute definition key; {} when the contact has none.
object
object
object
object
Base path for paginator generated URLs.
Number of items shown per page.
The “cursor” that points to the next set of items.
The “cursor” that points to the previous set of items.
Examplegenerated
{ "data": [ { "id": "example", "reference": "example", "email": "example", "status": "example", "locale": "example", "marketing": { "state": "example", "at": "example", "consented_at": "example", "consented_by_key": "example" }, "pixel_consent_at": "example", "attributes": {}, "tags": [ { "id": "example", "key": "example", "name": "example", "color_code": "example" } ], "created_at": "example", "updated_at": "example" } ], "links": { "first": "example", "last": "example", "prev": "example", "next": "example" }, "meta": { "path": "example", "per_page": 1, "next_cursor": "example", "prev_cursor": "example" }}Headers
Section titled “Headers”This request’s id. Quote it when you ask us about the request.
The API key is missing, malformed, revoked or expired.
object
What went wrong, for a person to read. It may change, so branch on code.
What went wrong, for your code to branch on. A new code is not a breaking change.
The entry on our errors page that explains this code.
This request’s id, the same as its Request-Id header. Quote it when you ask us about the request.
Example
{ "code": "unauthenticated"}Headers
Section titled “Headers”This request’s id. Quote it when you ask us about the request.
Nothing is at this path for your key. Another platform’s or another workspace’s resource answers the same as one that doesn’t exist.
object
What went wrong, for a person to read. It may change, so branch on code.
What went wrong, for your code to branch on. A new code is not a breaking change.
The entry on our errors page that explains this code.
This request’s id, the same as its Request-Id header. Quote it when you ask us about the request.
Example
{ "code": "not_found"}Headers
Section titled “Headers”This request’s id. Quote it when you ask us about the request.
The request is invalid. The code says why, and errors names each field at fault.
object
What went wrong, for a person to read. It may change, so branch on code.
What went wrong, for your code to branch on. A new code is not a breaking change.
Each field that failed validation, by its path in the request, with its messages.
object
The entry on our errors page that explains this code.
This request’s id, the same as its Request-Id header. Quote it when you ask us about the request.
Example
{ "code": "validation_failed"}Headers
Section titled “Headers”This request’s id. Quote it when you ask us about the request.
Too many requests. Wait for the seconds in Retry-After.
object
What went wrong, for a person to read. It may change, so branch on code.
What went wrong, for your code to branch on. A new code is not a breaking change.
The entry on our errors page that explains this code.
This request’s id, the same as its Request-Id header. Quote it when you ask us about the request.
Example
{ "code": "rate_limited"}Headers
Section titled “Headers”This request’s id. Quote it when you ask us about the request.
Seconds to wait before trying again.