Skip to content
SendTruss

Get a contact

GET
/workspaces/{workspace}/contacts/{contact}
curl --request GET \
  --url https://api.sendtruss.com/v1/workspaces/example/contacts/example \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
workspace
required
string
/^(?:[0-9A-Za-z]{26}|ref:[A-Za-z0-9._-]{1,128})$/

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.

contact
required
string
/^(?:[0-9A-Za-z]{26}|ref:[A-Za-z0-9._-]{1,128})$/

The contact: our id, or ref: plus your reference for the person, such as ref:guest_998. A reference is letters, digits, ., _ and -, up to 128 characters, and needs no URL encoding.

Responses

Section titled “Responses”

200

Section titled “200”

ContactResource

Media typeapplication/json
object
data
required
object
id
required
string
reference
required
string | null
email
required
string
status
required

The marketing state: pending until you send consent, then subscribed or unsubscribed.

string
locale
required
string | null
marketing
required

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
state
required
string
at
required
string | null
consented_at
required
string | null
consented_by_key
required
string | null
pixel_consent_at
required

When the person agreed to open tracking, or null.

string | null
attributes
required

Values by attribute definition key; {} when the contact has none.

object
tags
required
Array<object>
TagResource
object
id
required
string
key
required
string
name
required
string
color_code
required
string | null
created_at
required
string | null
updated_at
required
string | null
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"
  }
}

Headers

Section titled “Headers”
Request-Id
required
string format: uuid

This request’s id. Quote it when you ask us about the request.

401

Section titled “401”

The API key is missing, malformed, revoked or expired.

Media typeapplication/json
object
message
required

What went wrong, for a person to read. It may change, so branch on code.

string
code
required

What went wrong, for your code to branch on. A new code is not a breaking change.

string
Allowed values: unauthenticated
doc_url
required

The entry on our errors page that explains this code.

string format: uri
request_id
required

This request’s id, the same as its Request-Id header. Quote it when you ask us about the request.

string format: uuid
Example
{
  "code": "unauthenticated"
}

Headers

Section titled “Headers”
Request-Id
required
string format: uuid

This request’s id. Quote it when you ask us about the request.

404

Section titled “404”

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.

Media typeapplication/json
object
message
required

What went wrong, for a person to read. It may change, so branch on code.

string
code
required

What went wrong, for your code to branch on. A new code is not a breaking change.

string
Allowed values: not_found
doc_url
required

The entry on our errors page that explains this code.

string format: uri
request_id
required

This request’s id, the same as its Request-Id header. Quote it when you ask us about the request.

string format: uuid
Example
{
  "code": "not_found"
}

Headers

Section titled “Headers”
Request-Id
required
string format: uuid

This request’s id. Quote it when you ask us about the request.

429

Section titled “429”

Too many requests. Wait for the seconds in Retry-After.

Media typeapplication/json
object
message
required

What went wrong, for a person to read. It may change, so branch on code.

string
code
required

What went wrong, for your code to branch on. A new code is not a breaking change.

string
Allowed values: rate_limited
doc_url
required

The entry on our errors page that explains this code.

string format: uri
request_id
required

This request’s id, the same as its Request-Id header. Quote it when you ask us about the request.

string format: uuid
Example
{
  "code": "rate_limited"
}

Headers

Section titled “Headers”
Request-Id
required
string format: uuid

This request’s id. Quote it when you ask us about the request.

Retry-After
integer

Seconds to wait before trying again.