Sign in

v1

latestOpenAPI 3.1.12026-07-2452287575.4 KB
Contacts

Retrieve a Contact

Retrieve an existing Contact object

get/v1/companies/{company_id}/contacts/{id}

Path parameters

company_idstring uuid required
Example:8c581d79-bb84-4bc1-b1c5-8c073264a569

The Company ID.

idstring uuid required
Example:8c581d79-bb84-4bc1-b1c5-8c073264a569

The ID for the resource being accessed.

Response

OK

object'Contact' required

The object’s type (Contact).

idstring uuid required

The Contact ID.

default_contact_for_company_management'actionable' | 'read_only' | 'none' | '' | 'self_managed' required

This field controls how both the Routable dashboard and API will autofill contacts for emails related to company management such as inviting a company to submit their payment information.

  • When set to actionable, the contact will be able to take action on emails related to company management.
  • When set to read_only, the contact will only receive emails related to company management.
  • When set to none, the contact will not receive emails related to company management.
default_contact_for_payable_and_receivable'actionable' | 'read_only' | 'none' | '' | 'self_managed' required

This field controls how both the Routable dashboard and API will autofill contacts for emails related to payables and receivables.

  • When set to actionable, the contact will be able to take action on emails related to payables and receivables.
  • When set to read_only, the contact will only receive emails related to payables and receivables.
  • When set to none, the contact will not receive emails related to payables and receivables.
emailstring email nullable

The email for this contact.

first_namestring

The first name of this contact.

is_archivedboolean required

Whether the contact is archived.

last_email_delivery_problem'auto_responder' | 'hard_bounce' | 'refused' | 'soft_bounce' | 'spam_complaint' | 'spam_notification' | 'transient' | 'unknown' nullable

Describes an error that was encountered the last time an email was sent to this Contact via the Routable application. If the last email had no errors, this value will be null.

ValueDescription
auto_responderAutomatic email responder (ex: "Out of Office" or "On Vacation").
hard_bounceThe server was unable to deliver your message (ex: unknown user, mailbox not found).
refusedEmail service has asked that the address not be used. Which could be because it is not a valid email address, or the recipient has requested an address change.
soft_bounceTemporarily unable to deliver the message (i.e. mailbox full, account disabled, exceeds quota, out of disk space).
spam_complaintThe subscriber explicitly marked this message as spam.
spam_notificationThe message was delivered, but was either blocked by the user, or classified as spam, bulk mail, or had rejected content.
transientThe server temporarily could not deliver your message (ex: Message is delayed due to network troubles). This may be re-tried and eventually resolve or become a different error.
unknownAn unknown error occurred when sending the previous email.
last_namestring

The last name of this contact.

phone_numberstring required

An E.164-formatted telephone number.

phone_number_country'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AO' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PS' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'XK' | 'XX' | 'WF' | 'WS' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' required

Country code in ISO 3166-1 Alpha-2 format.