GET
/
contacts
/
{id}
curl --request GET \
  --url https://api.stateset.com/v1/contacts/{id} \
  --header 'Authorization: Bearer <token>'
{
  "account_id": "<string>",
  "assistant": "<string>",
  "assistant_phone": "<string>",
  "avatar": "<string>",
  "birthdate": "<string>",
  "controller": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": "<string>",
  "department": "<string>",
  "description": "<string>",
  "do_not_call": true,
  "email": "<string>",
  "email_opt_out": true,
  "fax": "<string>",
  "fax_opt_out": true,
  "firstName": "<string>",
  "handle": "<string>",
  "id": "<string>",
  "invalid_contact": true,
  "languages": "<string>",
  "lastName": "<string>",
  "last_modified_by": "<string>",
  "leadSource": "<string>",
  "mailingCity": "<string>",
  "mailingCountry": "<string>",
  "mailingGeocodeAccuracy": "<string>",
  "mailingState": "<string>",
  "mailingStreet": "<string>",
  "nextMeeting": "2023-12-25",
  "owner": "<string>",
  "phone": "<string>",
  "photoUrl": "<string>",
  "processor": "<string>",
  "title": "<string>",
  "user_id": "<string>",
  "vendor_id": "<string>"
}

Authorizations

Authorization
string
headerrequired

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

id
string
required

The id that needs to be fetched

Response

200 - application/json
account_id
string

The unique identifier for the account associated with the contact.

assistant
string

The assistant of the contact.

assistant_phone
string

The phone number of the assistant of the contact.

avatar
string

The avatar of the contact.

birthdate
string

The birthdate of the contact.

controller
string

The controller of the contact.

created_at
string

The date and time when the contact was created.

created_by
string

The user who created the contact.

department
string

The department of the contact.

description
string

The description of the contact.

do_not_call
boolean

Whether the contact should not be called.

email
string

The email address of the contact.

email_opt_out
boolean

Whether the contact has opted out of receiving emails.

fax
string

The fax number of the contact.

fax_opt_out
boolean

Whether the contact has opted out of receiving faxes.

firstName
string

The first name of the contact.

handle
string

The handle of the contact.

id
string

The unique identifier for the contact.

invalid_contact
boolean

Whether the contact is invalid.

languages
string

The languages spoken by the contact.

lastName
string

The last name of the contact.

last_modified_by
string

The user who last modified the contact.

leadSource
string

The lead source of the contact.

mailingCity
string

The city of the mailing address of the contact.

mailingCountry
string

The country of the mailing address of the contact.

mailingGeocodeAccuracy
string

The geocode accuracy of the mailing address of the contact.

mailingState
string

The state of the mailing address of the contact.

mailingStreet
string

The street address of the mailing address of the contact.

nextMeeting
string

The date of the next meeting with the contact.

owner
string

The owner of the contact.

phone
string

The phone number of the contact.

photoUrl
string

The URL of the photo of the contact.

processor
string

The processor of the contact.

title
string

The title of the contact.

user_id
string

The unique identifier for the user associated with the contact.

vendor_id
string