GET

/v1/accounts/:id

Bearer*

​
Body

id
string

This is the id of the account.

​
Response

idrequired
string

This is the id of the account.

accountNamerequired
string

This is the account name of the account.

accountNotesrequired
string

This is the account notes of the account.

accountSubtyperequired
string

This is the account subtype of the account.

accountTyperequired
string

This is the account type of the account.

account_ownerrequired
string

This is the account owner of the account.

account_sourcerequired
string

This is the account source of the account.

annualRevenuerequired
string

This is the annual revenue of the account.

avatarrequired
string

This is the avatar of the account.

billingCityrequired
string

This is the billing city of the account.

billingCountryrequired
string

This is the billing country of the account.

billingLatituderequired
string

This is the billing latitude of the account.

billingLongituderequired
string

This is the billing longitude of the account.

billingStaterequired
string

This is the billing state of the account.

billingStreetrequired
string

This is the billing street of the account.

created_atrequired
string

This is the created at of the account.

descriptionrequired
string

This is the description of the account.

employeesrequired
string

This is the employees of the account.

faxrequired
string

This is the fax of the account.

industryrequired
string

This is the industry of the account.

is_activerequired
string

This is the is active of the account.

is_publicrequired
string

This is the is public of the account.

last_modified_byrequired
string

This is the last modified by of the account.

numberOfEmployeesrequired
string

This is the number of employees of the account.

ownershiprequired
string

This is the ownership of the account.

phonerequired
string

This is the phone of the account.

ratingrequired
string

This is the rating of the account.

shippingCityrequired
string

This is the shipping city of the account.

shippingCountryrequired
string

This is the shipping country of the account.

shippingLatituderequired
string

This is the shipping latitude of the account.

shippingLongituderequired
string

This is the shipping longitude of the account.

shippingStaterequired
string

This is the shipping state of the account.

shippingStreetrequired
string

This is the shipping street of the account.

sicCoderequired
string

This is the sic code of the account.

tickerSymbolrequired
string

This is the ticker symbol of the account.

websiterequired
string

This is the website of the account.

yearStartedrequired
string

This is the year started of the account.

zipCoderequired
string

This is the zip code of the account.

created_byrequired
string

This is the created by of the account.

updated_byrequired
string

This is the updated by of the account.

curl --location --request GET 'https://api.stateset.com/v1/customer' \
--header 'Content-Type: application/json' \
--header 'Authorization: Token <token>' \
--data-raw '{
    "user_group_id": "example_1",
    "name": "Example 1",
    "mapping": {"40": "213", "134": "386"},
    "properties": {"filterValue": "value"}
}'

{

    "count": 1,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": "1",
            "accountName": "Test Account",
            "accountNotes": "Test Account Notes",
            "accountSubtype": "Test Account Subtype",
            "accountType": "Test Account Type",
            "account_owner": "Test Account Owner",
            "account_source": "Test Account Source",
            "annualRevenue": "Test Annual Revenue",
            "avatar": "Test Avatar",
            "billingCity": "Test Billing City",
            "billingCountry": "Test Billing Country",
            "billingLatitude": "Test Billing Latitude",
            "billingLongitude": "Test Billing Longitude",
            "billingState": "Test Billing State",
            "billingStreet": "Test Billing Street",
            "created_at": "2021-04-27T15:00:00.000000Z",
            "description": "Test Description",
            "employees": "Test Employees",
            "fax": "Test Fax",
            "industry": "Test Industry",
            "is_active": true,
            "is_public": true,
            "last_modified_by": "Test Last Modified By",
            "numberOfEmployees": "Test Number Of Employees",
            "ownership": "Test Ownership",
            "phone": "Test Phone",
            "rating": "Test Rating",
            "shippingCity": "Test Shipping City",
            "shippingCountry": "Test Shipping Country",
            "shippingLatitude": "Test Shipping Latitude",
            "shippingLongitude": "Test Shipping Longitude",
            "shippingState": "Test Shipping State",
            "shippingStreet": "Test Shipping Street",
            "sicCode": "Test Sic Code",
            "tickerSymbol": "Test Ticker Symbol",
            "website": "Test Website",
            "yearStarted": "Test Year Started",
            "zipCode": "Test Zip Code",
            "created_by": "Test Created By",
            "updated_by": "Test Updated By"
        }
    ]

}

​
Accounts

Accounts describes the general data about the accounts in Stateset.

​
The account object

​
Attributes

NameTypeDescription
idTextUnique identifier for the account
accountNameTextName of the account
accountNotesTextNotes or additional information about the account
accountSubtypeTextSubtype or specific category of the account
accountTypeTextType or general category of the account
account_ownerTextOwner or responsible person for the account
account_sourceTextSource or origin of the account
annualRevenueTextAnnual revenue associated with the account
avatarTextURL or path to the account’s avatar image
billingCityTextCity of the billing address
billingCountryTextCountry of the billing address
billingLatitudeTextLatitude coordinate of the billing address
billingLongitudeTextLongitude coordinate of the billing address
billingStateTextState or province of the billing address
billingStreetTextStreet address of the billing address
created_atDate/TimeDate and time when the account was created
descriptionTextDescription or additional details about the account
employeesTextNumber or range of employees associated with the account
faxTextFax number of the account
industryTextIndustry or sector of the account
is_activeBooleanIndicates whether the account is currently active
is_publicBooleanIndicates whether the account is public or private
last_modified_byTextLast person who modified the account
numberOfEmployeesTextNumber of employees associated with the account
ownershipTextOwnership type or structure of the account
parentAccountTextParent account associated with the account
phoneTextPhone number of the account
ratingTextRating or evaluation of the account
shippingCityTextCity of the shipping address
shippingCountryTextCountry of the shipping address
shippingLatitudeTextLatitude coordinate of the shipping address
shippingLongitudeTextLongitude coordinate of the shipping address
shippingStateTextState or province of the shipping address
shippingStreetTextStreet address of the shipping address
stockTickerTextStock ticker symbol associated with the account
websiteTextWebsite URL of the account
yearStartedTextYear the account was started or established
List AccountsCreate Account