API reference / Settings

Settings API

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

GET

List organizations

/api/v1/organizations

Scope:

Example request

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

GET

Get organization

/api/v1/organizations/{id}

Scope:

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

Example request

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

POST

Update organization

/api/v1/organizations/{id}

Scope: Scalar360.settings.CREATE

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

Body field	Type	Required	Notes
`gid`	string (uuid)
`name`	string	Yes	required
`legalName`	string
`gstin`	string
`pan`	string
`email`	string
`phone`	string
`address`	string
`state`	string
`pin`	string
`bankAccountNo`	string
`bankName`	string
`bankIfsc`	string
`bankAddress`	string
`financialYearStart`	string
`taxPreference`	string
`logoUrl`	string
`accentColor`	string
`invoiceFooter`	string
`invoiceTemplate`	string
`deliveryNoteTemplate`	string
`deliveryNoteFooter`	string
`deliveryNoteAccent`	string
`deliveryNoteLogoUrl`	string
`deliveryProvider`	string
`deliveryApiUrl`	string
`deliveryApiKey`	string
`deliveryApiEnabled`	boolean
`deliveryApiConfig`	string
`payslipTemplate`	string
`payslipNote`	string
`termsAndConditions`	string
`invoiceLayoutConfig`	string
`status`	string
`timezone`	string
`booksLockedUntil`	string (date)
`booksLockedByUserId`	integer
`booksLockedAt`	string (date-time)
`openingBalanceDate`	string (date)
`createdAt`	string (date-time)
`updatedAt`	string (date-time)

Example request

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

GET

Invitations

/api/v1/organizations/{id}/invitations

Scope: Scalar360.settings.READ

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

Example request

curl -X GET "https://api.scalar360.com/api/v1/organizations/{id}/invitations" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

GET

Members

/api/v1/organizations/{id}/members

Scope: Scalar360.settings.READ

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

Example request

curl -X GET "https://api.scalar360.com/api/v1/organizations/{id}/members" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

GET

Permissions

/api/v1/organizations/{id}/permissions

Scope: Scalar360.settings.READ

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

Example request

curl -X GET "https://api.scalar360.com/api/v1/organizations/{id}/permissions" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

GET

List

/api/v1/organizations/{id}/roles

Scope: Scalar360.settings.READ

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

Example request

curl -X GET "https://api.scalar360.com/api/v1/organizations/{id}/roles" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

POST

Create

/api/v1/organizations/{id}/roles

Scope: Scalar360.settings.CREATE

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

Body field	Type	Required	Notes
`name`	string
`menuKeys`	array of string

Example request

curl -X POST "https://api.scalar360.com/api/v1/organizations/{id}/roles" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","menuKeys":["string"]}'

GET

Seat usage

/api/v1/organizations/{id}/seat-usage

Scope: Scalar360.settings.READ

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

Example request

curl -X GET "https://api.scalar360.com/api/v1/organizations/{id}/seat-usage" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

GET

Get settings

/api/v1/organizations/{id}/settings

Scope: Scalar360.settings.READ

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

Example request

curl -X GET "https://api.scalar360.com/api/v1/organizations/{id}/settings" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

POST

Transfer

/api/v1/organizations/{orgGid}/transfer-ownership

Scope: Scalar360.settings.CREATE

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

Body field	Type	Required	Notes
`membershipId`	string (uuid)	Yes
`confirmName`	string	Yes	required, not blank

Example request

curl -X POST "https://api.scalar360.com/api/v1/organizations/{orgGid}/transfer-ownership" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"membershipId":"3f1c2b9e-7a1d-4c3e-9b2a-1e5f6a7b8c9d","confirmName":"string"}'

POST

Invite

/api/v1/organizations/invitations

Scope: Scalar360.settings.CREATE

Body field	Type	Required	Notes
`email`	string	Yes	required, not blank, valid email
`name`	string	Yes	required, not blank
`role`	string
`roleName`	string
`organizationIds`	array of string	Yes	required, not empty
`menuKeys`	array of string
`permissionsByOrganization`	map of array of string
`roleId`	string (uuid)

Example request

curl -X POST "https://api.scalar360.com/api/v1/organizations/invitations" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"email":"string","name":"string","organizationIds":["string"]}'

DELETE

Revoke

/api/v1/organizations/invitations/{id}

Scope: Scalar360.settings.DELETE

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

Example request

curl -X DELETE "https://api.scalar360.com/api/v1/organizations/invitations/{id}" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

POST

Resend

/api/v1/organizations/invitations/{id}/resend

Scope: Scalar360.settings.CREATE

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

Example request

curl -X POST "https://api.scalar360.com/api/v1/organizations/invitations/{id}/resend" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

PATCH

Update membership

/api/v1/organizations/memberships/{id}

Scope: Scalar360.settings.UPDATE

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

Body field	Type	Required	Notes
`role`	string
`roleName`	string
`menuKeys`	array of string
`roleId`	string (uuid)

Example request

curl -X PATCH "https://api.scalar360.com/api/v1/organizations/memberships/{id}" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"role":"string","roleName":"string","menuKeys":["string"],"roleId":"3f1c2b9e-7a1d-4c3e-9b2a-1e5f6a7b8c9d"}'

DELETE

Remove membership

/api/v1/organizations/memberships/{id}

Scope: Scalar360.settings.DELETE

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

Example request

curl -X DELETE "https://api.scalar360.com/api/v1/organizations/memberships/{id}" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

GET

Get

/api/v1/organizations/roles/{roleId}

Scope: Scalar360.settings.READ

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

Example request

curl -X GET "https://api.scalar360.com/api/v1/organizations/roles/{roleId}" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

PUT

Update

/api/v1/organizations/roles/{roleId}

Scope: Scalar360.settings.UPDATE

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

Body field	Type	Required	Notes
`name`	string
`menuKeys`	array of string

Example request

curl -X PUT "https://api.scalar360.com/api/v1/organizations/roles/{roleId}" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","menuKeys":["string"]}'

DELETE

Delete

/api/v1/organizations/roles/{roleId}

Scope: Scalar360.settings.DELETE

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

Example request

curl -X DELETE "https://api.scalar360.com/api/v1/organizations/roles/{roleId}" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

POST

Review

/api/v1/organizations/roles/{roleId}/review

Scope: Scalar360.settings.CREATE

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

Example request

curl -X POST "https://api.scalar360.com/api/v1/organizations/roles/{roleId}/review" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

Settings API

List organizations

Get organization

Update organization

Directory

Invitations

Members

Permissions

List

Create

Seat usage

Get settings

Transfer

Invite

Revoke

Resend

Update membership

Remove membership

Get

Update

Delete

Review