Accounts by service

get https://app.upswot.com/{tenant}/api/v1/normalized-data/{companyId}/crm/accounts/{serviceId}

Get company accounts by service id.

Path Params

companyId

uuid

required

Company ID to get data

serviceId

uuid

required

Service ID to get data

Query Params

PageNumber

int32

1 to 9999

Page number
Default - 1

PageSize

int32

10 to 500

Objects per page
Default - 100

OrderBy

Property to sort by

Desc

boolean

Sort by ascending or descending order. Descending by default.

FilterQuery

string

length ≤ 2048

Filter by entity field
Available values: serviceName, origId, name, typeApp, industryApp, statusSystem, numberOfEmployees, annualRevenueOrigCurrency, email.value, website.value, manager.origId, manager.name, addresses.typeSystem, addresses.addressFull, addresses.postCode, addresses.region, addresses.city, addresses.street, addresses.countryApp, addresses.countryCode.
For more info visit here.

Responses

Response body

object

serviceId

uuid

Service identifier in a third-party app

serviceName

string | null

Service name

lastUpdatedOn

date-time | null

Date of last update

data

array of objects | null

Row with objects

data

object

serviceId

uuid

Service identifier in a third-party app.

serviceName

string | null

Service name.

lastUpdatedOn

date-time | null

Date of the last update.

uuid

Internal identifier.

origId

string | null

Account identifier in a third-party app.

name

string | null

Account name.

typeApp

string | null

Account type in the third-party app: "ACCOUNT", "ORGANIZATION", "CONTACT".

legalName

string | null

Legal name of the client.

subTypeApp

string | null

Account subtype in the third-party app: "INDIVIDUAL", "CUSTOMER", "VENDOR".

ownershipApp

string | null

Ownership right name in the third-party app.

createDate

date-time | null

Account creation date.

array of objects | null

object

value

string | null

Account email.

type

string | null

Account email type: "MAIN", "OTHER".

gender

string | null

Account gender.

dateOfBirth

date-time | null

Account birthday.

website

array of objects | null

website

object

value

string | null

Account website.

type

string | null

Account type of website: "MAIN", "OTHER".

manager

array of objects | null

manager

object

origId

string | null

Manager identifier.

typeSystem

string | null

UPTIQ's manager type: "CREATOR", "OWNER", "RESPONSIBLE".

name

string | null

Manager name.

statusSystem

string | null

Manager status in the UPTIQ system: "ACTIVE", "INACTIVE".

industryApp

string | null

Industry name in the third-party app.

sourceName

string | null

Appearance source name in the third-party app: "Web", "Cold call", "Advertisement", "Online Store", other.

statusSystem

string | null

Status in the UPTIQ system: "ACTIVE", "INACTIVE".

description

string | null

Additional information about the account (details, description, comments).

numberOfEmployees

int32

Number of employees.

annualRevenueOrigCurrency

int32

Account annual income.

currencyApp

string | null

Account basic currency.

position

string | null

Account position.

leadConvertedDate

date-time | null

Date of lead conversion to an agreement or a real customer.

identifiers

array of objects | null

identifiers

object

typeApp

string | null

Name or identifier code in the third-party app:
- NAICS: 6-digit NAICS code (North American Industry Classifier),
- DUNS: 9-digit unique identifier assigned to the business entity,
- SIC: 4-digit industry classification code (The Standard Industrial Classification for classifying industries).

value

string | null

Identifier value.

phones

array of objects | null

phones

object

typeSystem

string | null

Phone type in the UPTIQ system: "MOBILE", "MAIN", "OTHER".

number

string | null

Phone number.

addresses

array of objects | null

addresses

object

typeSystem

string | null

Address type in the UPTIQ system:
"BILLING" - billing address,
"SHIPPING" - shipping address,
"MAIN" - actual head office address,
"LEGAL" - registered office address,
"OTHER" - other.

typeApp

string | null

Address type in a third-party app.

addressFull

string | null

Full address (template: Address Line 1 + " " + Address Line 2 + " + " +...Address Line x + " + City + " + Region + " + Postal Code + " + Country).

postCode

string | null

Postcode.

region

string | null

Region.

city

string | null

City.

street

string | null

Street name, house number (template: Address Line 1 + " " + Address Line 2 + "...").

countryApp

string | null

Country name in a third-party app.

countryCode

string | null

Country code (ISO 3166-3 Country Codes).

pagination

object

pageNumber

int32

Page number

pageSize

int32

Objects per page

count

int32

Total objects count

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://app.upswot.com/admin/api/v1/normalized-data/companyId/crm/accounts/serviceId \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

400Problems with parameters

401Your request was not properly authorized

403Access Denied

404There is no company(service) with such ID

500Server-side Issue