API reference / Contacts

Contacts API

16 endpoints. Scopes: Scalar360.contacts.READ, .CREATE, .UPDATE, .DELETE or .ALL. All calls need Authorization: Scalar360-oauthtoken <access_token> — see Authentication.

GET

Get all contacts

/api/contacts

Scope: Scalar360.contacts.READ

Parameter	In	Type	Required
`page`	query	integer	No
`pageSize`	query	integer	No
`size`	query	integer	No
`q`	query	string (default )	No
`search`	query	string (default )	No
`source`	query	string (default )	No
`origin`	query	string (default )	No
`hasGstin`	query	string (default )	No
`startDate`	query	string (date)	No
`endDate`	query	string (date)	No
`sortBy`	query	string	No
`sortDir`	query	string (default desc)	No

Example request

curl -X GET "https://api.scalar360.com/api/contacts" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

POST

Create contact

/api/contacts

Scope: Scalar360.contacts.CREATE

Body field	Type	Required	Notes
`name`	string	Yes	required
`companyName`	string
`phone`	string	Yes
`email`	string
`gstin`	string
`billingAddress`	string
`shippingAddress`	string
`state`	string
`pin`	string
`source`	string
`assignedTo`	string
`notes`	string
`customFields`	map of string

Example request

curl -X POST "https://api.scalar360.com/api/contacts" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","phone":"string"}'

GET

Get contact by gid

/api/contacts/{gid}

Scope: Scalar360.contacts.READ

Parameter	In	Type	Required
`gid`	path	string (uuid)	Yes

Example request

curl -X GET "https://api.scalar360.com/api/contacts/{gid}" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

PUT

Update contact

/api/contacts/{gid}

Scope: Scalar360.contacts.UPDATE

Parameter	In	Type	Required
`gid`	path	string (uuid)	Yes

Body field	Type	Required	Notes
`name`	string	Yes	required
`companyName`	string
`phone`	string
`email`	string
`gstin`	string
`billingAddress`	string
`shippingAddress`	string
`state`	string
`pin`	string
`source`	string
`assignedTo`	string
`notes`	string
`customFields`	map of string

Example request

curl -X PUT "https://api.scalar360.com/api/contacts/{gid}" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","companyName":"string","phone":"string","email":"string","gstin":"string","billingAddress":"string"}'

DELETE

Delete contact

/api/contacts/{gid}

Scope: Scalar360.contacts.DELETE

Parameter	In	Type	Required
`gid`	path	string (uuid)	Yes

Example request

curl -X DELETE "https://api.scalar360.com/api/contacts/{gid}" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

GET

List activities

/api/contacts/{gid}/activities

Scope: Scalar360.contacts.READ

Parameter	In	Type	Required
`gid`	path	string (uuid)	Yes

Example request

curl -X GET "https://api.scalar360.com/api/contacts/{gid}/activities" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

POST

Add activity

/api/contacts/{gid}/activities

Scope: Scalar360.contacts.CREATE

Parameter	In	Type	Required
`gid`	path	string (uuid)	Yes

Body field	Type	Required	Notes
`type`	string	Yes	required, not blank
`note`	string
`activityTime`	string (date-time)
`mentions`	array of string (uuid)

Example request

curl -X POST "https://api.scalar360.com/api/contacts/{gid}/activities" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"type":"string"}'

DELETE

Delete activity

/api/contacts/{gid}/activities/{activityGid}

Scope: Scalar360.contacts.DELETE

Parameter	In	Type	Required
`gid`	path	string (uuid)	Yes
`activityGid`	path	string (uuid)	Yes

Example request

curl -X DELETE "https://api.scalar360.com/api/contacts/{gid}/activities/{activityGid}" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

GET

List documents

/api/contacts/{gid}/documents

Scope: Scalar360.contacts.READ

Parameter	In	Type	Required
`gid`	path	string (uuid)	Yes

Example request

curl -X GET "https://api.scalar360.com/api/contacts/{gid}/documents" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

POST

Upload document

/api/contacts/{gid}/documents

Scope: Scalar360.contacts.CREATE

Parameter	In	Type	Required
`gid`	path	string (uuid)	Yes
`activityId`	query	string (uuid)	No

Request body: multipart/form-data with a file field.

Example request

curl -X POST "https://api.scalar360.com/api/contacts/{gid}/documents" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN" \
  -F "file=@/path/to/file"

DELETE

Delete document

/api/contacts/{gid}/documents/{docGid}

Scope: Scalar360.contacts.DELETE

Parameter	In	Type	Required
`gid`	path	string (uuid)	Yes
`docGid`	path	string (uuid)	Yes

Example request

curl -X DELETE "https://api.scalar360.com/api/contacts/{gid}/documents/{docGid}" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

GET

Document link

/api/contacts/{gid}/documents/{docGid}/link

Scope: Scalar360.contacts.READ

Parameter	In	Type	Required
`gid`	path	string (uuid)	Yes
`docGid`	path	string (uuid)	Yes

Example request

curl -X GET "https://api.scalar360.com/api/contacts/{gid}/documents/{docGid}/link" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

GET

Contact emails

/api/contacts/{gid}/emails

Scope: Scalar360.contacts.READ

Parameter	In	Type	Required
`gid`	path	string (uuid)	Yes

Example request

curl -X GET "https://api.scalar360.com/api/contacts/{gid}/emails" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

POST

Import contacts

/api/contacts/import

Scope: Scalar360.contacts.CREATE

Request body: multipart/form-data with a file field.

Example request

curl -X POST "https://api.scalar360.com/api/contacts/import" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN" \
  -F "file=@/path/to/file"

GET

Template csv

/api/contacts/import/template.csv

Scope: Scalar360.contacts.READ

Example request

curl -X GET "https://api.scalar360.com/api/contacts/import/template.csv" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

GET

Template xlsx

/api/contacts/import/template.xlsx

Scope: Scalar360.contacts.READ

Example request

curl -X GET "https://api.scalar360.com/api/contacts/import/template.xlsx" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"