Get tasks
GET /api/2.0/crm/task/filter
Request
Returns a list of tasks matching the parameters specified in the request.
Authorization
An API key is a token that you provide when making API calls. Include the token in a header parameter called Authorization
.
Example: Authorization: 864FE52C-1C1C-469F-9308-51DAFEFE7436
.
Headers
- Accept
enum of string
Can be one of:
application/json
.- Content-Type
enum of string
Can be one of:
application/json
.
Body
- responsibleid
string
Task responsible ID
- categoryid
integer
Task category ID
- isClosed
array of boolean
Task status
- fromDate
string
Earliest task due date
- toDate
string
Latest task due date
- entityType
string
Related entity type
- entityid
integer
Related entity ID
Examples
GET /api/2.0/crm/task/filter HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.com
curl --request GET \
--url https://example.com/api/2.0/crm/task/filter \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Responses
200
List of all tasks
- CreateBy
object
- Id
string
uuid - DisplayName
string
- Title
string
- AvatarSmall
string
- ProfileUrl
string
- Created
string
- Contact
object
- Email
object
- InfoType
enum of integer
int32 [0 - Phone, 1 - Email, 2 - Website, 3 - Skype, 4 - Twitter, 5 - LinkedIn, 6 - Facebook, 7 - Address, 8 - LiveJournal, 9 - MySpace, 10 - GMail, 11 - Blogger, 12 - Yahoo, 13 - MSN, 14 - ICQ, 15 - Jabber, 16 - AIM, 17 - VK]
Can be one of:
Phone
,Email
,Website
,Skype
,Twitter
,LinkedIn
,Facebook
,Address
,LiveJournal
,MySpace
,GMail
,Blogger
,Yahoo
,MSN
,ICQ
,Jabber
,AIM
,VK
.- Category
integer
int32 - Data
string
- CategoryName
string
- IsPrimary
boolean
- ID
integer
int32
- SmallFotoUrl
string
- MediumFotoUrl
string
- DisplayName
string
- IsCompany
boolean
- AccessList
array of object
- Id
string
uuid - DisplayName
string
- Title
string
- AvatarSmall
string
- ProfileUrl
string
- IsPrivate
boolean
- IsShared
boolean
- ShareType
enum of integer
int32 [0 - None, 1 - ReadWrite, 2 - Read]
Can be one of:
None
,ReadWrite
,Read
.- Currency
object
- Title
string
- Symbol
string
- Abbreviation
string
- CultureName
string
- IsConvertable
boolean
- IsBasic
boolean
- CanEdit
boolean
- CanDelete
boolean
- ID
integer
int32
- Title
string
- Description
string
- DeadLine
string
- AlertValue
integer
int32 - Responsible
object
- Id
string
uuid - DisplayName
string
- Title
string
- AvatarSmall
string
- ProfileUrl
string
- IsClosed
boolean
- Category
object
- ImagePath
string
- Title
string
- Description
string
- Color
string
- SortOrder
integer
int32 - ID
integer
int32
- Entity
object
- EntityType
string
- EntityId
integer
int32 - EntityTitle
string
- CanEdit
boolean
- ID
integer
int32
401
Unauthorized