Skip to main content
GET
/
v1
/
partners
/
{partner_id}
/
contacts
/
{contact_id}
Retrieve A Contact
curl --request GET \
  --url http://api.stuut.ai/v1/partners/{partner_id}/contacts/{contact_id} \
  --header 'Authorization: Bearer <token>'
{
  "email": "<string>",
  "object": "<string>",
  "partner_id": "<string>",
  "id": "<string>",
  "address": {
    "object": "<string>",
    "city": "<string>",
    "coordinates": {},
    "country": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "line1": "<string>",
    "line2": "<string>",
    "modified_at": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "phone": "<string>",
    "postal_code": "<string>",
    "remote_id": "<string>",
    "state": "<string>",
    "type": "<string>"
  },
  "address_id": 123,
  "addresses": [
    {
      "object": "<string>",
      "id": "<string>",
      "city": "<string>",
      "coordinates": {},
      "country": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "is_primary": true,
      "line1": "<string>",
      "line2": "<string>",
      "modified_at": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "postal_code": "<string>",
      "state": "<string>",
      "type": "<string>"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "custom_fields": "<unknown>",
  "external_role": "billing_contact",
  "family_name": "<string>",
  "given_name": "<string>",
  "internal_role": "account_manager",
  "is_email_disabled": true,
  "is_phone_disabled": true,
  "is_primary": true,
  "is_primary_email": true,
  "is_primary_phone": true,
  "job_title": "<string>",
  "modified_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "phone": "<string>",
  "remote_created_at": "2023-11-07T05:31:56Z",
  "remote_id": "<string>",
  "remote_metadata": "<unknown>",
  "remote_modified_at": "2023-11-07T05:31:56Z",
  "status_metadata": "<unknown>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
partner_id
string
required
​
contact_id
string
required

Response

Successful response

​
email
string
required

The contact's email address.

Maximum string length: 255
​
object
string
required
​
partner_id
string
required
Maximum string length: 32
​
id
string
Maximum string length: 32
​
address
object
​
address_id
integer | null
​
addresses
object[]
​
created_at
string<date-time>
​
custom_fields
any
​
external_role
enum<string> | null

The external contact's role.

Available options:
billing_contact,
executive,
economic_user,
Maximum string length: 15
​
family_name
string | null

If an individual, the contact's family name.

​
given_name
string | null

If an individual, the contact's given name.

​
internal_role
enum<string> | null

The internal contact's role.

Available options:
account_manager,
account_executive,
csm,
Maximum string length: 17
​
is_email_disabled
boolean

Whether the contact's email has been deemed invalid.

​
is_phone_disabled
boolean

Whether the contact's email has been deemed invalid.

​
is_primary
boolean

Whether the contact is a primary contact for the partner.

​
is_primary_email
boolean

Whether the contact is the primary email contact for the partner.

​
is_primary_phone
boolean

Whether the contact is the primary phone contact for the partner.

​
job_title
string | null

The contact's job at their company.

​
modified_at
string<date-time> | null
​
name
string | null

The contact's name, if no given/family name.

​
phone
string | null

The contact's phone number.

Maximum string length: 32
​
remote_created_at
string<date-time> | null

When the third party's entry was created.

​
remote_id
string | null

The contact's third party API ID.

​
remote_metadata
unknown
​
remote_modified_at
string<date-time> | null

When the third party's entry was updated.

​
status_metadata
any

Holds metadata about why contact channel statuses changed, has source (email or call) as key values (e.g. {'email'|'call': {status: 'enabled'|'disabled', reason: str, timestamp: datetime}})