Contacts

Get a list of Contacts.

get/api/v1/Contacts

Request

  • Base URL: https://api.cin7.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.cin7.com/api/v1/Contacts
  • Auth: none declared

Query parameters

fieldsstring

A comma-separated list of field names

wherestring

Filter by an any element

orderstring

Order by any element returned

pageinteger

The page number (default: 1)

rowsinteger

Rows per page (default: 50, maximum: 250)

Response

OK

idinteger

The unique Cin7 Id.

createdDatestring date-time

Created Date

modifiedDatestring date-time

Modified Date

isActiveboolean nullable

Is Active. Defaults to true on create; left unchanged on update when omitted.

companystring nullable

Company

firstNamestring nullable

First Name

lastNamestring nullable

Last Name

jobTitlestring nullable

Job Title

emailstring email nullable

A unique email address

websitestring nullable

Website

phonestring nullable

Phone

faxstring nullable

Fax

mobilestring nullable

Mobile

address1string nullable

Address 1

address2string nullable

Address 2

citystring nullable

City

statestring nullable

State

postCodestring nullable

Post Code

countrystring nullable

Country

postalAddress1string nullable

Billing/Postal Address 1

postalAddress2string nullable

Billing/Postal Address 2

postalCitystring nullable

Billing/Postal City

postalPostCodestring nullable

Billing/Postal Post Code

postalStatestring nullable

Billing/Postal State

postalCountrystring nullable

Billing/Postal Country

notesstring nullable

Notes

integrationRefstring nullable

Integration reference.

customFieldsobject nullable

Custom fields.

type0 | 1 | 2 required

ContactType

salesPersonIdinteger

The User Id

accountNumberstring nullable

Account Number

billingIdinteger nullable

Parent company member id

billingCompanystring nullable

Billing Company

accountsFirstNamestring nullable

Accounts contact first name

accountsLastNamestring nullable

Accounts contact last name

billingEmailstring nullable

Billing Email

accountsPhonestring nullable

Accounts contact phone

billingCostCenterstring nullable

Alternative GL account of a Parent company if exists

costCenterstring nullable

Alternative GL account

priceColumnstring nullable

A price column name. Query ProductOptions to get a list of valid price column names.

percentageOffnumber double nullable

Percentage Off Price Tier. Price discount on top of PriceColumn.

paymentTermsstring nullable

Payment terms

taxStatusstring nullable

Tax Status

taxNumberstring nullable

Taxt Number

creditLimitnumber double nullable

Credit Limit

balanceOwingnumber double nullable

Balance Owing

onHoldboolean nullable

Hold Status

groupstring nullable

Group

subGroupstring nullable

Subgroup

stagesstring nullable

Stages

Changes

No recorded changes to this operation across all 1 revision of this API.