Skip to main content
GET
https://api.stateset.com
/
v1
/
contacts
/
:id
curl --location --request GET 'https://api.stateset.com/v1/contacts/:id' \
--header 'Content-Type: application/json' \
--header 'Authorization: Token <token>' \
--data-raw '{
    "id": "example_1",
}'

{
  "success": 1,
  "new_user_group": true,
  "user_group": {
    "team_id": 3,
    "token": "<user_group_token_to_auth_dashboard>",
    "name": "Example 1",
    "provided_id": "example_1"
  }
}

​
Body

​
id
text
required
The ID of the user group to which the contact belongs.

​
Response

​
id
text
The ID of the contact.
​
assistant
text
Name or details of the assistant associated with the contact.
​
assistant_phone
text
Phone number of the assistant.
​
avatar
text
URL or path to the contact’s avatar image.
​
birthdate
text
Date of birth of the contact.
​
controller
text
Name or details of the controller associated with the contact.
​
created_at
datetime
Date and time when the contact was created.
​
created_by
text
Name or details of the person who created the contact.
​
department
text
Department or division associated with the contact.
​
description
text
Description or additional details about the contact.
​
do_not_call
boolean
Indicates whether the contact should not be called.
​
email
text
Email address of the contact.
​
email_opt_out
boolean
Indicates whether the contact has opted out of email communication.
​
fax
text
Fax number of the contact.
​
fax_opt_out
boolean
Indicates whether the contact has opted out of fax communication.
​
firstName
text
First name of the contact.
​
handle
text
Handle or username associated with the contact.
​
invalid_contact
boolean
Indicates whether the contact is marked as invalid.
​
languages
text
Languages known or spoken by the contact.
​
lastName
text
Last name of the contact.
​
last_modified_by
text
Last person who modified the contact.
​
leadSource
text
Source or origin of the lead/contact.
​
mailingCity
text
City of the mailing address.
​
mailingCountry
text
Country of the mailing address.
​
mailingGeocodeAccuracy
text
Geocoding accuracy of the mailing address.
​
mailingState
text
State or province of the mailing address.
​
mailingStreet
text
Street of the mailing address.
​
owner
text
Name or details of the owner of the contact.
​
phone
text
Phone number of the contact.
​
photoUrl
text
URL or path to the contact’s photo.
​
processor
text
Name or details of the processor associated with the contact.
​
title
text
Title or position of the contact.
curl --location --request GET 'https://api.stateset.com/v1/contacts/:id' \
--header 'Content-Type: application/json' \
--header 'Authorization: Token <token>' \
--data-raw '{
    "id": "example_1",
}'

{
  "success": 1,
  "new_user_group": true,
  "user_group": {
    "team_id": 3,
    "token": "<user_group_token_to_auth_dashboard>",
    "name": "Example 1",
    "provided_id": "example_1"
  }
}
NameTypeDescription
idTextUnique identifier for the contact
assistantTextName or details of the assistant associated with the contact
assistant_phoneTextPhone number of the assistant
avatarTextURL or path to the contact’s avatar image
birthdateTextDate of birth of the contact
controllerTextName or details of the controller associated with the contact
created_atDate/TimeDate and time when the contact was created
created_byTextName or details of the person who created the contact
departmentTextDepartment or division associated with the contact
descriptionTextDescription or additional details about the contact
do_not_callBooleanIndicates whether the contact should not be called
emailTextEmail address of the contact
email_opt_outBooleanIndicates whether the contact has opted out of email communication
faxTextFax number of the contact
fax_opt_outBooleanIndicates whether the contact has opted out of fax communication
firstNameTextFirst name of the contact
handleTextHandle or username associated with the contact
invalid_contactBooleanIndicates whether the contact is marked as invalid
languagesTextLanguages known or spoken by the contact
lastNameTextLast name of the contact
last_modified_byTextLast person who modified the contact
leadSourceTextSource or origin of the lead/contact
mailingCityTextCity of the mailing address
mailingCountryTextCountry of the mailing address
mailingGeocodeAccuracyTextGeocoding accuracy of the mailing address
mailingStateTextState or province of the mailing address
mailingStreetTextStreet address of the mailing address
nextMeetingTextDetails or date/time of the next scheduled meeting
ownerTextOwner or responsible person for the contact
phoneTextPhone number of the contact
photoUrlTextURL or path to the contact’s photo/image
processorTextName or details of the processor associated with the contact
supplier_idTextSupplier ID associated with the contact
titleTextTitle or job position of the contact