Jump to Content
API Reference
v1.0
Log In
API Reference
Log In
v1.0
API Reference
Delete tax
JUMP TO
Uspacy api
Introduction
SDKs and boilerplates
authService
Sign in
post
Confirm user email
post
Refresh token
post
New user registration by invitation
post
Sign up
post
Initiate password reset
post
Change password with token
post
Update user password
patch
Update password
patch
Email existence check
get
usersService
Get users list
get
Get user by id
get
Update user data by id.
patch
Deactivate user by id
post
Activate user by id
post
Update user roles by id. Returns user data with new roles
patch
Update user position by id. Returns user data with new position
patch
Get user account settings by id.
get
Update user account settings by id.
patch
Get two-factor authentication status by id.
get
Disable two-factor authentication by id.
patch
Get self profile
get
Get two-factor authentication status
get
Enable two-factor authentication in a two steps
patch
Disable two-factor authentication
patch
Search
get
Avatar upload
post
Getting a list of users by filter. Available to unauthorized users.
post
Get self settings
get
Update self settings
patch
departments (usersService)
Get departments list
get
Create department.
post
Get department by id
get
Update department by id
patch
Delete department
del
Update department roles by id. Returns department data with new roles
patch
Update department users by id.
patch
Delete users from department
patch
roles (usersService)
Get permissions list.
get
Get roles list.
get
Create role.
post
Get role by id
get
Update role by id
patch
Delete role by id
del
invite (usersService)
Checking if an invitation exists.
get
Create invites.
post
Create invites.
post
Resend an invitation
patch
Delete invitation
del
custom fields (usersService)
Get available fields list.
get
Create field.
post
Get field by code.
get
Edit field by code.
patch
Delete field by code.
del
Get list elements. Available for all users.
get
Creating or editing list items.
post
Deleting a list item.
del
Get field sections list.
get
incoming webhooks (usersService)
Retrieve Incoming Webhooks List
get
Create Incoming Webhook
post
Mass Delete Incoming Webhooks
del
Update Incoming Webhook
patch
Delete Incoming Webhook
del
outgoing webhooks (usersService)
Retrieve Outgoing Webhooks List
get
Create a New Outgoing Webhook
post
Delete Multiple Outgoing Webhooks
del
Delete an Outgoing Webhook
del
Toggle Outgoing Webhook Status
patch
Repeat Outgoing Webhook Action
patch
tasksService
Get available tasks list
get
Create task
post
Get task by id
get
Edit task by id
patch
Delete task by id
del
Get kanban stages
get
Create kanban stage
post
Get kanban stage by id
get
Update kanban stage by id
patch
Delete kanban stage by id
del
Moving a task to stage
post
Get checklist by task id
get
Create checklist for task
post
Update checklist for task
patch
Delete checklist from task by id
del
Get checklist items by id
get
Create checklist for task
post
Delete item to checklist by id
del
Update checklist for task
patch
Bulk ready tasks
post
Bulk deletion tasks
post
Bulk editing tasks
post
Transfer tasks to another user.
post
Transfer tasks to department.
post
Take on a task.
patch
Stopped the task.
patch
Complete the task
patch
Restart the task
patch
Watch the task.
patch
Unwatch the task.
patch
Get available settings list
get
Update tasks settings
put
filesService
Lists the file info
get
Upload one or more files
post
Lists the file info
get
Lists the file info
get
Update file by id
patch
Delete file by id
del
Update files by entity
patch
Delete files by entity
del
groupService
Get groups list
get
Create group
post
Shows the group info
get
Update group. Only available to group owner.
patch
Delete group. Only available to group owner.
del
Upload group logo. Only available to group owner or moderator.
post
Adding a user to a group.
patch
Remove user from group.
patch
Adding the current user to the group.
patch
Remove the current user from the group.
patch
Getting a list of invitations to groups of the current user.
get
Sending invitations to groups. Only available to group owner.
post
Refusal of an invitation. Only available to the current user.
del
Transfer groups to another user.
post
Transfer groups to another user.
post
Transfer groups to another user.
post
Getting a list of invited users for particular private group
get
Add join request for private group
post
Check if user sent join request to the private group
get
Decline private group join request
del
searchService
Search data from all services
get
fileImport
/fileimport/v1/csv-import
post
appService
Get applications list.
get
Create app
post
Update app data
patch
Delete app
del
emailService
Retrieve Emails List
get
Retrieve Email by ID
get
Add Email Credentials
post
Update Email Credentials
patch
Add Email Settings
post
Update Email Settings
patch
Retrieve CRM integration settings for a specific email.
get
Update CRM integration settings for a specific email. Available only for mailbox owner or users with email role setter.
patch
Retrieve all email folders
get
Add a new folder to an email account
post
Delete an email folder
del
Get Signatures List
get
Create a New Signature
post
Update a Signature
patch
Delete an email signature
del
Retrieve Letters by Folder
get
Add Letter to Send Queue
post
Retrieve Letters by IDs
get
Delete Letters
del
Update Letter CRM Entities
patch
Move Letters to Folder
patch
Mark Letters as Read
patch
Mark Letters as Unread
patch
history
Get history for a specific service and entity
get
Messenger service
chats
Get all chats
get
Create a new chat
post
Update a chat
patch
Find chat by meta value
get
Find all chats by meta value
get
Get chat by ID
get
Delete a chat
del
Add members to chat
post
Remove members from chat
del
Leave a chat
post
Set chat active status
post
Pin a chat
post
Unpin a chat
post
Mute chat notifications
post
Unmute chat notifications
post
messages
Get messages from a chat
get
Send a new message
post
Edit a message
patch
Mark messages as read
post
Navigate to a specific message
get
Forward messages
post
Get pinned messages
get
Pin a message
post
Unpin a message
post
Delete multiple messages
del
Mark all messages as read
post
Delete a message
del
external-lines
Get all external lines
get
Create an external line
post
Get external line by ID
get
Delete an external line
del
Update an external line
patch
telephony
Start a phone call
post
End a phone call
post
search
Search messages globally
get
Search within a specific chat
get
Comments service
comments
Get comments list
get
Create a comment
post
Get comments for multiple entities
get
Update a comment
patch
Delete a comment
del
Delete all comments for an entity
del
NewsFeed Service
/newsfeed/v1/posts
Get posts list
get
Create post
post
/newsfeed/v1/posts/{postId}
Update post
patch
Delete post
del
Activities service
activities
Get activities list
get
Create activity
post
Show activity
get
Update activity
patch
Delete activity by id
del
Bulk deletion activities
del
CRM service
entities
Get available entities list
get
Create entity
post
Update entity
patch
Delete entity
del
fields
Get available field types list
get
Get available fields list
get
Create field
post
Get field by code
get
Edit field by code
patch
Delete field by code
del
List field dependencies
get
Create field dependency
post
Delete field dependency
del
Get list elements
get
Create or edit list items
post
Delete list item
del
items
Get CRM entity items list
get
Create CRM entity item
post
Get CRM entity item
get
Edit CRM entity item
patch
Delete CRM entity item
del
Mass edit CRM entity items
patch
Mass delete CRM entity items
del
Merge CRM entities
post
Upload entity avatar
post
Get entity tabs
get
Get related entity items
get
Convert CRM entity item
post
Get companies list (with filters)
get
Get contacts list (with filters)
get
Get deals list (with filters)
get
Get leads list (with filters)
get
Get leads fields list
get
pipeline
Get funnels
get
Create funnel
post
Get funnel by ID
get
Edit funnel
patch
Delete funnel
del
Get kanban stages
get
Create kanban stage
post
Get kanban stage
get
Edit kanban stage
patch
Delete kanban stage
del
Get stage items amount
get
Move entity to stage
post
Get funnel reasons
get
Create reason
post
Edit reason
patch
Delete reason
del
activities
Get CRM activities list
get
Create CRM activity
post
Get CRM activity
get
Edit CRM activity
patch
Delete CRM activity
del
Update activity
post
Mass delete CRM activities
del
CRM task handler (internal)
post
call events
Get call events list
get
Create call event
post
Get call event
get
Update call event
patch
Delete call event
del
Get caller information
get
letters
Handle CRM letter binding
post
Mark letter as processed
patch
Unbind letter from CRM entity
del
customer contacts
Get customer contacts
get
Bulk get entities by contacts
post
Get entities for a contact
get
products
Get product categories tree
get
Create product category
post
Get product category
get
Edit product category
patch
Delete product category
del
Get products list (with many filters)
get
Create product
post
Get product
get
Update product
patch
Delete product
del
Bulk create products
post
Mass delete products
del
Get measurement units
get
Create measurement unit
post
Update measurement unit
patch
Delete measurement unit
del
Get taxes list
get
Create tax
post
Update tax
patch
Delete tax
del
Get entity product list
get
Update entity product list
patch
Get list product
get
Update list product
patch
Delete list product
del
Create list product
post
Bulk create list products
post
Bulk update list products
patch
Bulk delete list products
del
Get product price types
get
Create product price type
post
Update product price type
patch
Delete product price type
del
documents
Get document templates list
get
Create document template
post
Mass delete document templates
del
Get document template
get
Update document template
patch
Get document available fields
get
Get available entities for filter
get
Get documents list
get
Generate document
post
Update document
patch
Delete document
del
Get document fields
get
Update document fields (fill values)
put
requisites
Get available regions
get
Get bank requisite fields for region
get
Get requisite templates
get
Create requisite template
post
Get basic requisite templates
get
Update requisite template
patch
Delete requisite template
del
Get requisites list
get
Create requisite
post
Get requisite values
get
Search/explore requisites
get
Get requisite by ID
get
Update requisite
patch
Delete requisite
del
Attach requisite to entity reference
post
Detach requisite from entity reference
del
Get bank requisites
get
Create bank requisite
post
Update bank requisite
patch
Delete bank requisite
del
Attach bank requisite reference
post
Detach bank requisite reference
del
permissions
Get funnel permissions list
get
Create/update CRM permissions
post
trash
Get removed/deleted items
get
Permanently delete trashed items
del
Get removed item details
get
Restore removed items
patch
transfers
Get transfer progress
get
Get quantity of items to transfer
post
Transfer CRM data to another user
post
Stop ongoing transfer
get
Powered by
Delete tax
Ask AI
delete
https://{domain}.uspacy.ua/crm/v1/static/taxes/
{itemId}
Language
Shell
Node
Ruby
PHP
Python
Credentials
Bearer
JWT
Bearer
URL
Base URL
https://
domain
.uspacy.ua
/crm/v1/static/taxes/{itemId}
Response
Click
Try It!
to start a request and see the response here!