StateSet API Docs

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_contact": true,
  "contact": {
    "team_id": 3,
    "token": "<contact_api_token>",
    "name": "Example 1",
    "provided_id": "example_1"
  }
}

GET

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_contact": true,
  "contact": {
    "team_id": 3,
    "token": "<contact_api_token>",
    "name": "Example 1",
    "provided_id": "example_1"
  }
}

Body

string

The name of the contact.

string

Your own identifier for this contact, if you track one.

object

A JSON object of custom properties stored against the contact.

Response

text

The ID of the contact.

text

Name or details of the assistant associated with the contact.

text

Phone number of the assistant.

text

URL or path to the contact’s avatar image.

text

Date of birth of the contact.

text

Name or details of the controller associated with the contact.

datetime

Date and time when the contact was created.

text

Name or details of the person who created the contact.

text

Department or division associated with the contact.

text

Description or additional details about the contact.

boolean

Indicates whether the contact should not be called.

text

Email address of the contact.

boolean

Indicates whether the contact has opted out of email communication.

text

Fax number of the contact.

boolean

Indicates whether the contact has opted out of fax communication.

text

First name of the contact.

text

Handle or username associated with the contact.

boolean

Indicates whether the contact is marked as invalid.

text

Languages known or spoken by the contact.

text

Last name of the contact.

text

Last person who modified the contact.

text

Source or origin of the lead/contact.

text

City of the mailing address.

text

Country of the mailing address.

text

Geocoding accuracy of the mailing address.

text

State or province of the mailing address.

text

Street of the mailing address.

text

Name or details of the owner of the contact.

text

Phone number of the contact.

text

URL or path to the contact’s photo.

text

Name or details of the processor associated with the contact.

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_contact": true,
  "contact": {
    "team_id": 3,
    "token": "<contact_api_token>",
    "name": "Example 1",
    "provided_id": "example_1"
  }
}

Name	Type	Description
id	Text	Unique identifier for 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	Date/Time	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 address of the mailing address
nextMeeting	Text	Details or date/time of the next scheduled meeting
owner	Text	Owner or responsible person for the contact
phone	Text	Phone number of the contact
photoUrl	Text	URL or path to the contact’s photo/image
processor	Text	Name or details of the processor associated with the contact
supplier_id	Text	Supplier ID associated with the contact
title	Text	Title or job position of the contact

List Contact Create Contact

StateSet One API

StateSet API v1

Customer Management

Order Management

Checkouts

Returns Management

Warranty Management

Wholesale Management

Inventory Management

ASN Management

Purchase Orders

Manufacturing

Warehouse Operations

CRM

Suppliers

E-commerce

Financial

Fulfillment

Communication

System

StateSet Response API

StateSet Cloud API

StateSet Commerce API

Get Contact

Body

Response

​Body

​Response

Body

Response