API reference / CRM

CRM API

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

GET

List

/api/crm/activity

Scope: Scalar360.crm.READ

Parameter	In	Type	Required
`page`	query	integer (default 1)	No
`pageSize`	query	integer (default 20)	No
`q`	query	string	No
`category`	query	string	No
`startDate`	query	string (date)	No
`endDate`	query	string (date)	No

Example request

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

GET

Analytics

/api/crm/analytics

Scope: Scalar360.crm.READ

Parameter	In	Type	Required
`from`	query	string (date)	No
`to`	query	string (date)	No
`pipeline`	query	string (uuid)	No
`owner`	query	string	No
`source`	query	string	No
`granularity`	query	string	No

Example request

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

GET

List

/api/crm/automations

Scope: Scalar360.crm.READ

Example request

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

POST

Create

/api/crm/automations

Scope: Scalar360.crm.CREATE

Body field	Type	Required	Notes
`name`	string	Yes	required, not blank
`triggerType`	string	Yes	required, not blank
`enabled`	boolean
`definition`	any

Example request

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

PUT

Update

/api/crm/automations/{gid}

Scope: Scalar360.crm.UPDATE

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

Body field	Type	Required	Notes
`name`	string	Yes	required, not blank
`triggerType`	string	Yes	required, not blank
`enabled`	boolean
`definition`	any

Example request

curl -X PUT "https://api.scalar360.com/api/crm/automations/{gid}" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","triggerType":"string","enabled":true,"definition":null}'

DELETE

Delete

/api/crm/automations/{gid}

Scope: Scalar360.crm.DELETE

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

Example request

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

PATCH

Set enabled

/api/crm/automations/{gid}/enabled

Scope: Scalar360.crm.UPDATE

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

Example request

curl -X PATCH "https://api.scalar360.com/api/crm/automations/{gid}/enabled" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

GET

Settings

/api/crm/email-settings

Scope: Scalar360.crm.READ

Example request

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

PUT

Save settings

/api/crm/email-settings

Scope: Scalar360.crm.UPDATE

Body field	Type	Required	Notes
`syncEnabled`	boolean
`sharing`	string
`mailbox`	string
`dropboxAddress`	string

Example request

curl -X PUT "https://api.scalar360.com/api/crm/email-settings" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"syncEnabled":true,"sharing":"string","mailbox":"string","dropboxAddress":"string"}'

GET

Content

/api/crm/emails/{gid}

Scope: Scalar360.crm.READ

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

Example request

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

GET

List forms

/api/crm/forms

Scope: Scalar360.crm.READ

Example request

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

POST

Create form

/api/crm/forms

Scope: Scalar360.crm.CREATE

Body field	Type	Required	Notes
`name`	string	Yes	required
`slug`	string
`title`	string
`description`	string
`successMessage`	string
`accentColor`	string
`defaultPipelineId`	string (uuid)
`defaultStage`	string
`defaultSource`	string
`fields`	array of object
`fields[].fieldKey`	string
`fields[].label`	string
`fields[].fieldType`	string
`fields[].required`	boolean
`fields[].visible`	boolean
`fields[].displayOrder`	integer
`fields[].options`	string
`fields[].custom`	boolean
`blocks`	array of object
`blocks[].id`	string
`blocks[].type`	string
`blocks[].text`	string
`blocks[].level`	integer
`blocks[].fieldKey`	string
`blocks[].label`	string
`blocks[].required`	boolean
`blocks[].fieldType`	string
`blocks[].options`	string
`blocks[].custom`	boolean
`blocks[].span`	integer
`blocks[].displayOrder`	integer
`blocks[].layout`	map of object
`theme`	object
`theme.fontFamily`	string
`theme.headingColor`	string
`theme.textColor`	string
`theme.labelColor`	string
`theme.backgroundColor`	string
`theme.cardColor`	string
`theme.buttonColor`	string
`theme.buttonTextColor`	string
`theme.buttonLabel`	string
`theme.buttonRadius`	integer
`theme.fieldGap`	integer
`allowedOrigins`	array of string

Example request

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

GET

Get form

/api/crm/forms/{gid}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}}

Scope: Scalar360.crm.READ

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

Example request

curl -X GET "https://api.scalar360.com/api/crm/forms/{gid}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}}" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

PUT

Update form

/api/crm/forms/{gid}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}}

Scope: Scalar360.crm.UPDATE

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

Body field	Type	Required	Notes
`name`	string	Yes	required
`slug`	string
`title`	string
`description`	string
`successMessage`	string
`accentColor`	string
`defaultPipelineId`	string (uuid)
`defaultStage`	string
`defaultSource`	string
`fields`	array of object
`fields[].fieldKey`	string
`fields[].label`	string
`fields[].fieldType`	string
`fields[].required`	boolean
`fields[].visible`	boolean
`fields[].displayOrder`	integer
`fields[].options`	string
`fields[].custom`	boolean
`blocks`	array of object
`blocks[].id`	string
`blocks[].type`	string
`blocks[].text`	string
`blocks[].level`	integer
`blocks[].fieldKey`	string
`blocks[].label`	string
`blocks[].required`	boolean
`blocks[].fieldType`	string
`blocks[].options`	string
`blocks[].custom`	boolean
`blocks[].span`	integer
`blocks[].displayOrder`	integer
`blocks[].layout`	map of object
`theme`	object
`theme.fontFamily`	string
`theme.headingColor`	string
`theme.textColor`	string
`theme.labelColor`	string
`theme.backgroundColor`	string
`theme.cardColor`	string
`theme.buttonColor`	string
`theme.buttonTextColor`	string
`theme.buttonLabel`	string
`theme.buttonRadius`	integer
`theme.fieldGap`	integer
`allowedOrigins`	array of string

Example request

curl -X PUT "https://api.scalar360.com/api/crm/forms/{gid}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}}" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","slug":"string","title":"string","description":"string","successMessage":"string","accentColor":"string"}'

DELETE

Delete form

/api/crm/forms/{gid}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}}

Scope: Scalar360.crm.DELETE

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

Example request

curl -X DELETE "https://api.scalar360.com/api/crm/forms/{gid}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}}" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

POST

Publish form

/api/crm/forms/{gid}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}}/publish

Scope: Scalar360.crm.CREATE

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

Example request

curl -X POST "https://api.scalar360.com/api/crm/forms/{gid}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}}/publish" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

POST

Unpublish form

/api/crm/forms/{gid}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}}/unpublish

Scope: Scalar360.crm.CREATE

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

Example request

curl -X POST "https://api.scalar360.com/api/crm/forms/{gid}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}}/unpublish" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

GET

Field catalog

/api/crm/forms/field-catalog

Scope: Scalar360.crm.READ

Example request

curl -X GET "https://api.scalar360.com/api/crm/forms/field-catalog" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

GET

List lead priorities

/api/crm/lead-priorities

Scope: Scalar360.crm.READ

Example request

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

POST

Create lead priority

/api/crm/lead-priorities

Scope: Scalar360.crm.CREATE

Body field	Type	Required	Notes
`name`	string
`color`	string
`displayOrder`	integer
`active`	boolean

Example request

curl -X POST "https://api.scalar360.com/api/crm/lead-priorities" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","color":"string","displayOrder":1,"active":true}'

PUT

Update lead priority

/api/crm/lead-priorities/{gid}

Scope: Scalar360.crm.UPDATE

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

Body field	Type	Required	Notes
`name`	string
`color`	string
`displayOrder`	integer
`active`	boolean

Example request

curl -X PUT "https://api.scalar360.com/api/crm/lead-priorities/{gid}" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","color":"string","displayOrder":1,"active":true}'

DELETE

Delete lead priority

/api/crm/lead-priorities/{gid}

Scope: Scalar360.crm.DELETE

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

Example request

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

GET

List lead sources

/api/crm/lead-sources

Scope: Scalar360.crm.READ

Example request

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

POST

Create lead source

/api/crm/lead-sources

Scope: Scalar360.crm.CREATE

Body field	Type	Required	Notes
`name`	string
`color`	string
`displayOrder`	integer
`active`	boolean

Example request

curl -X POST "https://api.scalar360.com/api/crm/lead-sources" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","color":"string","displayOrder":1,"active":true}'

PUT

Update lead source

/api/crm/lead-sources/{gid}

Scope: Scalar360.crm.UPDATE

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

Body field	Type	Required	Notes
`name`	string
`color`	string
`displayOrder`	integer
`active`	boolean

Example request

curl -X PUT "https://api.scalar360.com/api/crm/lead-sources/{gid}" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","color":"string","displayOrder":1,"active":true}'

DELETE

Delete lead source

/api/crm/lead-sources/{gid}

Scope: Scalar360.crm.DELETE

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

Example request

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

GET

List lead types

/api/crm/lead-types

Scope: Scalar360.crm.READ

Example request

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

POST

Create lead type

/api/crm/lead-types

Scope: Scalar360.crm.CREATE

Body field	Type	Required	Notes
`name`	string
`color`	string
`displayOrder`	integer
`active`	boolean

Example request

curl -X POST "https://api.scalar360.com/api/crm/lead-types" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","color":"string","displayOrder":1,"active":true}'

PUT

Update lead type

/api/crm/lead-types/{gid}

Scope: Scalar360.crm.UPDATE

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

Body field	Type	Required	Notes
`name`	string
`color`	string
`displayOrder`	integer
`active`	boolean

Example request

curl -X PUT "https://api.scalar360.com/api/crm/lead-types/{gid}" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","color":"string","displayOrder":1,"active":true}'

DELETE

Delete lead type

/api/crm/lead-types/{gid}

Scope: Scalar360.crm.DELETE

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

Example request

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

GET

Start oauth

/api/crm/meta/oauth/start

Scope: Scalar360.crm.READ

Example request

curl -X GET "https://api.scalar360.com/api/crm/meta/oauth/start" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

GET

List pages

/api/crm/meta/pages

Scope: Scalar360.crm.READ

Example request

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

DELETE

Disconnect

/api/crm/meta/pages/{pageId}

Scope: Scalar360.crm.DELETE

Parameter	In	Type	Required
`pageId`	path	string	Yes

Example request

curl -X DELETE "https://api.scalar360.com/api/crm/meta/pages/{pageId}" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

POST

Connect

/api/crm/meta/pages/{pageId}/connect

Scope: Scalar360.crm.CREATE

Parameter	In	Type	Required
`pageId`	path	string	Yes

Body field	Type	Required	Notes
`leadSource`	string
`pipelineId`	string (uuid)

Example request

curl -X POST "https://api.scalar360.com/api/crm/meta/pages/{pageId}/connect" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"leadSource":"string","pipelineId":"3f1c2b9e-7a1d-4c3e-9b2a-1e5f6a7b8c9d"}'

GET

Forms

/api/crm/meta/pages/{pageId}/forms

Scope: Scalar360.crm.READ

Parameter	In	Type	Required
`pageId`	path	string	Yes

Example request

curl -X GET "https://api.scalar360.com/api/crm/meta/pages/{pageId}/forms" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

PUT

Save form mapping

/api/crm/meta/pages/{pageId}/forms/{formId}/mapping

Scope: Scalar360.crm.UPDATE

Parameter	In	Type	Required
`pageId`	path	string	Yes
`formId`	path	string	Yes

Body field	Type	Required	Notes
`formName`	string
`mappings`	map of string
`leadSource`	string
`pipelineId`	string (uuid)

Example request

curl -X PUT "https://api.scalar360.com/api/crm/meta/pages/{pageId}/forms/{formId}/mapping" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"formName":"string","mappings":{},"leadSource":"string","pipelineId":"3f1c2b9e-7a1d-4c3e-9b2a-1e5f6a7b8c9d"}'

GET

Status

/api/crm/meta/status

Scope: Scalar360.crm.READ

Example request

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

GET

List pipelines

/api/crm/pipelines

Scope: Scalar360.crm.READ

Example request

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

POST

Create pipeline

/api/crm/pipelines

Scope: Scalar360.crm.CREATE

Body field	Type	Required	Notes
`name`	string
`displayOrder`	integer

Example request

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

PUT

Update pipeline

/api/crm/pipelines/{gid}

Scope: Scalar360.crm.UPDATE

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

Body field	Type	Required	Notes
`name`	string
`displayOrder`	integer

Example request

curl -X PUT "https://api.scalar360.com/api/crm/pipelines/{gid}" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","displayOrder":1}'

DELETE

Delete pipeline

/api/crm/pipelines/{gid}

Scope: Scalar360.crm.DELETE

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

Example request

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

GET

List pipeline stages

/api/crm/pipelines/{gid}/stages

Scope: Scalar360.crm.READ

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

Example request

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

PUT

Replace pipeline stages

/api/crm/pipelines/{gid}/stages

Scope: Scalar360.crm.UPDATE

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

Body field	Type	Required	Notes
`key`	string
`label`	string
`visible`	boolean
`system`	boolean
`winProbability`	integer

Example request

curl -X PUT "https://api.scalar360.com/api/crm/pipelines/{gid}/stages" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '[{"key":"string","label":"string","visible":true,"system":true,"winProbability":1}]'

PUT

Reorder pipelines

/api/crm/pipelines/order

Scope: Scalar360.crm.UPDATE

Example request

curl -X PUT "https://api.scalar360.com/api/crm/pipelines/order" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '["3f1c2b9e-7a1d-4c3e-9b2a-1e5f6a7b8c9d"]'

GET

Dashboard

/api/v1/crm/dashboard

Scope: Scalar360.crm.READ

Example request

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