Download OpenAPI specification:Download
UseResponse is a complex platform to support customers and social CRM but if you use other systems for project management, invoicing, billing, hosting, you can enhance your experience with customers by integrating our Restful API into your platform.
With UseResponse API you can use following REST commands over HTTP using JSON: POST, GET. PUT, DELETE. All requests should be done to your platform (resource URL) preferably using the https protocol. Make sure to use cURL to make requests, SDK or from your command line.
All requests are done in JSON format. Examples of requests and responses are stated in each section of the documentation.
In order to make any requests to UseResponse API, you'll need to authorize your requests by providing a valid API key. If guest API is available, you can make requests without providing any API Key.
But first, you need to enable Restful API in Administration » Applications where you can manage the API settings. You have the ability to turn off API, use guest API, and set permissions to use it only for specific admins and agents.
To fetch the data, you need to have permissions that are defined by the agent team in the system. For example, if you'll use guest API, you would get only those information, that is available to guests in the community.
API Keys could be taken and regenerated at User Profile - Options - API Settings. You can also turn off keys for specific users.
There is also option to set trusted domains in the settings in order to allow making api requests only from specific hosts.
{- "email": "support@useresponse.com",
- "password": "123456"
}
{- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}
ownership | string Example: ownership=feedback Filters the result by given ownership |
type | string Example: type=idea Filters the result by given object type |
[- {
- "description": null,
- "forum": {
- "id": "string",
- "name": "string"
}, - "id": 0,
- "image": {
- "big": "string",
- "medium": "string",
- "small": "string"
}, - "isPrivate": true,
- "name": "string",
- "order": 0,
- "ownership": null,
- "parent_id": 0,
- "slug": "string",
- "type": null
}
]
{- "description": null,
- "forum": {
- "id": "string",
- "name": "string"
}, - "id": 0,
- "image": {
- "big": "string",
- "medium": "string",
- "small": "string"
}, - "isPrivate": true,
- "name": "string",
- "order": 0,
- "ownership": null,
- "parent_id": 0,
- "slug": "string",
- "type": null
}
[- {
- "actions": [
- {
- "change_id": "string",
- "field": "string",
- "previous": "string",
- "value": "string"
}
], - "createdAtPosix": 0,
- "createdBy": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "source": "string"
}
]
[- {
- "actions": [
- {
- "change_id": "string",
- "field": "string",
- "previous": "string",
- "value": "string"
}
], - "createdAtPosix": 0,
- "createdBy": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "source": "string"
}
]
authorId | integer Example: authorId=10 Filters the result by given user id |
page | integer Example: page=3 Specifies the page of results to retrieve |
{- "success": {
- "currentPage": 0,
- "data": [
- {
- "author": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "completedAt": "string",
- "completedAtPosix": 0,
- "createdAt": "string",
- "createdAtPosix": 0,
- "externalId": 0,
- "id": 0,
- "lastMessage": {
- "author": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "content": "string",
- "createdAtPosix": 0,
- "fileName": "string",
- "id": 0,
- "isSystem": true,
- "parentId": 0,
- "token": "string",
- "type": "string"
}, - "responsible": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "score": 0,
- "seenByClient": true,
- "source": "string",
- "title": "string",
- "token": "string",
- "updatedAt": "string",
- "updatedAtPosix": 0
}
], - "firstPage": 0,
- "lastPage": 0,
- "nextPage": 0,
- "objectsPerPage": 0,
- "totalObjects": 0,
- "totalPages": 0
}
}
{- "success": {
- "author": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "completedAt": "string",
- "completedAtPosix": 0,
- "createdAt": "string",
- "createdAtPosix": 0,
- "externalId": 0,
- "id": 0,
- "lastMessage": {
- "author": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "content": "string",
- "createdAtPosix": 0,
- "fileName": "string",
- "id": 0,
- "isSystem": true,
- "parentId": 0,
- "token": "string",
- "type": "string"
}, - "responsible": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "score": 0,
- "seenByClient": true,
- "source": "string",
- "title": "string",
- "token": "string",
- "updatedAt": "string",
- "updatedAtPosix": 0
}
}
{- "success": {
- "attachments": [
- {
- "directUrl": "string",
- "icon": "string",
- "id": 0,
- "name": {
- "ext": "string",
- "full": "string",
- "short": "string"
}, - "url": "string"
}
], - "author": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "content": "string",
- "createdAgo": "string",
- "createdAt": "string",
- "createdAtPosix": 0,
- "id": 0,
- "is_best": 0,
- "objectId": 0,
- "ownership": "string",
- "replyToId": 0,
- "updatedAt": "string",
- "votes": {
- "amount": 0,
- "canVote": true,
- "isVoted": true,
- "plural": "string"
}
}
}
reason | string In case a comment or topic is declined you can specify decline reason |
{- "reason": "Too little information provided"
}
{- "success": {
- "attachments": [
- {
- "directUrl": "string",
- "icon": "string",
- "id": 0,
- "name": {
- "ext": "string",
- "full": "string",
- "short": "string"
}, - "url": "string"
}
], - "author": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "content": "string",
- "createdAgo": "string",
- "createdAt": "string",
- "createdAtPosix": 0,
- "id": 0,
- "is_best": 0,
- "objectId": 0,
- "ownership": "string",
- "replyToId": 0,
- "updatedAt": "string",
- "votes": {
- "amount": 0,
- "canVote": true,
- "isVoted": true,
- "plural": "string"
}
}
}
{- "success": {
- "attachments": [
- {
- "directUrl": "string",
- "icon": "string",
- "id": 0,
- "name": {
- "ext": "string",
- "full": "string",
- "short": "string"
}, - "url": "string"
}
], - "author": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "bestComment": {
- "attachments": [
- {
- "directUrl": "string",
- "icon": "string",
- "id": 0,
- "name": {
- "ext": "string",
- "full": "string",
- "short": "string"
}, - "url": "string"
}
], - "author": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "content": "string",
- "createdAgo": "string",
- "createdAt": "string",
- "createdAtPosix": 0,
- "id": 0,
- "is_best": 0,
- "objectId": 0,
- "ownership": "string",
- "replyToId": 0,
- "updatedAt": "string",
- "votes": {
- "amount": 0,
- "canVote": true,
- "isVoted": true,
- "plural": "string"
}
}, - "canBeCommented": true,
- "category": {
- "description": null,
- "forum": {
- "id": "string",
- "name": "string"
}, - "id": 0,
- "image": {
- "big": "string",
- "medium": "string",
- "small": "string"
}, - "isPrivate": true,
- "name": "string",
- "order": 0,
- "ownership": null,
- "parent_id": 0,
- "slug": "string",
- "type": null
}, - "commentedAt": "string",
- "commentsNum": 0,
- "completedBy": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "completedOn": "string",
- "content": "string",
- "createdAt": "string",
- "createdAtPosix": 0,
- "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "forum": {
- "id": "string",
- "name": "string"
}, - "id": 0,
- "isAbused": true,
- "isFeatured": true,
- "isPrivate": true,
- "isSubscribed": 0,
- "language": "string",
- "latestActivityPosix": 0,
- "links": [
- {
- "object_id": "string",
- "title": "string",
- "type": "string",
- "url": "string"
}
], - "ownership": "string",
- "parentObject": null,
- "recipients": [
- "string"
], - "responsible": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "score": 0,
- "scoreComment": "string",
- "scoreReason": "string",
- "slaDatePosix": 0,
- "slug": "string",
- "source": {
- "identifier": "string",
- "name": "string"
}, - "state": {
- "identifier": 0,
- "name": "string"
}, - "status": {
- "color": {
- "background": "string",
- "text": "string"
}, - "id": 0,
- "isClosed": true,
- "isDefault": true,
- "isSystem": true,
- "order": 0,
- "ownership": "string",
- "slug": "string",
- "title": "string",
- "type": "string"
}, - "tags": [
- "string"
], - "team": {
- "id": 0,
- "name": "string"
}, - "title": "string",
- "type": {
- "icon": {
- "big": "string",
- "small": "string"
}, - "order": 0,
- "slug": "string",
- "supports": {
- "comments": true,
- "negativeVote": true,
- "votes": true
}, - "title": {
- "plural": "string",
- "single": "string"
}
}, - "url": "string",
- "views": 0,
- "votes": {
- "all": 0,
- "canVote": true,
- "isVoted": true,
- "negative": 0,
- "plural": "string",
- "positive": 0
}
}
}
reason | string In case a comment or topic is declined you can specify decline reason |
{- "reason": "Too little information provided"
}
{- "success": {
- "attachments": [
- {
- "directUrl": "string",
- "icon": "string",
- "id": 0,
- "name": {
- "ext": "string",
- "full": "string",
- "short": "string"
}, - "url": "string"
}
], - "author": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "bestComment": {
- "attachments": [
- {
- "directUrl": "string",
- "icon": "string",
- "id": 0,
- "name": {
- "ext": "string",
- "full": "string",
- "short": "string"
}, - "url": "string"
}
], - "author": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "content": "string",
- "createdAgo": "string",
- "createdAt": "string",
- "createdAtPosix": 0,
- "id": 0,
- "is_best": 0,
- "objectId": 0,
- "ownership": "string",
- "replyToId": 0,
- "updatedAt": "string",
- "votes": {
- "amount": 0,
- "canVote": true,
- "isVoted": true,
- "plural": "string"
}
}, - "canBeCommented": true,
- "category": {
- "description": null,
- "forum": {
- "id": "string",
- "name": "string"
}, - "id": 0,
- "image": {
- "big": "string",
- "medium": "string",
- "small": "string"
}, - "isPrivate": true,
- "name": "string",
- "order": 0,
- "ownership": null,
- "parent_id": 0,
- "slug": "string",
- "type": null
}, - "commentedAt": "string",
- "commentsNum": 0,
- "completedBy": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "completedOn": "string",
- "content": "string",
- "createdAt": "string",
- "createdAtPosix": 0,
- "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "forum": {
- "id": "string",
- "name": "string"
}, - "id": 0,
- "isAbused": true,
- "isFeatured": true,
- "isPrivate": true,
- "isSubscribed": 0,
- "language": "string",
- "latestActivityPosix": 0,
- "links": [
- {
- "object_id": "string",
- "title": "string",
- "type": "string",
- "url": "string"
}
], - "ownership": "string",
- "parentObject": null,
- "recipients": [
- "string"
], - "responsible": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "score": 0,
- "scoreComment": "string",
- "scoreReason": "string",
- "slaDatePosix": 0,
- "slug": "string",
- "source": {
- "identifier": "string",
- "name": "string"
}, - "state": {
- "identifier": 0,
- "name": "string"
}, - "status": {
- "color": {
- "background": "string",
- "text": "string"
}, - "id": 0,
- "isClosed": true,
- "isDefault": true,
- "isSystem": true,
- "order": 0,
- "ownership": "string",
- "slug": "string",
- "title": "string",
- "type": "string"
}, - "tags": [
- "string"
], - "team": {
- "id": 0,
- "name": "string"
}, - "title": "string",
- "type": {
- "icon": {
- "big": "string",
- "small": "string"
}, - "order": 0,
- "slug": "string",
- "supports": {
- "comments": true,
- "negativeVote": true,
- "votes": true
}, - "title": {
- "plural": "string",
- "single": "string"
}
}, - "url": "string",
- "views": 0,
- "votes": {
- "all": 0,
- "canVote": true,
- "isVoted": true,
- "negative": 0,
- "plural": "string",
- "positive": 0
}
}
}
date | string Enum: "today" "yesterday" "this_week" "last_week" "this_month" "last_month" Filters the result by given date range |
is_private | integer Default: 0 Enum: 0 1 Request returns private notes if this field is set to 1 |
sort | string Default: "asc" Enum: "asc" "desc" Sort comments by creation date |
{- "success": [
- {
- "attachments": [
- {
- "directUrl": "string",
- "icon": "string",
- "id": 0,
- "name": {
- "ext": "string",
- "full": "string",
- "short": "string"
}, - "url": "string"
}
], - "author": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "content": "string",
- "createdAgo": "string",
- "createdAt": "string",
- "createdAtPosix": 0,
- "id": 0,
- "is_best": 0,
- "objectId": 0,
- "ownership": "string",
- "replyToId": 0,
- "updatedAt": "string",
- "votes": {
- "amount": 0,
- "canVote": true,
- "isVoted": true,
- "plural": "string"
}
}
]
}
content required | string The content of a new object. Supports BBcode, but HTML tags are not allowed Max content length: 12000 chars |
is_private | integer If 1 specified, comment will be saved as private note. To add private note you should have agent’s or admin’s privileges Valid values: 0, 1 |
object_id | integer Valid object(ticket/topic) id |
reply_to | integer Valid comment id to make reply to comment |
treat_as_html | integer API would accept “content” parameter in HTML format. Overrides “Accept HTML Content” global setting for one request Valid values: 0, 1 |
{- "content": "My first comment",
- "is_private": 0,
- "object_id": 38,
- "reply_to": 10,
- "treat_as_html": 0
}
{- "success": {
- "attachments": [
- {
- "directUrl": "string",
- "icon": "string",
- "id": 0,
- "name": {
- "ext": "string",
- "full": "string",
- "short": "string"
}, - "url": "string"
}
], - "author": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "content": "string",
- "createdAgo": "string",
- "createdAt": "string",
- "createdAtPosix": 0,
- "id": 0,
- "is_best": 0,
- "objectId": 0,
- "ownership": "string",
- "replyToId": 0,
- "updatedAt": "string",
- "votes": {
- "amount": 0,
- "canVote": true,
- "isVoted": true,
- "plural": "string"
}
}
}
{- "success": {
- "attachments": [
- {
- "directUrl": "string",
- "icon": "string",
- "id": 0,
- "name": {
- "ext": "string",
- "full": "string",
- "short": "string"
}, - "url": "string"
}
], - "author": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "content": "string",
- "createdAgo": "string",
- "createdAt": "string",
- "createdAtPosix": 0,
- "id": 0,
- "is_best": 0,
- "objectId": 0,
- "ownership": "string",
- "replyToId": 0,
- "updatedAt": "string",
- "votes": {
- "amount": 0,
- "canVote": true,
- "isVoted": true,
- "plural": "string"
}
}
}
content | string The content of a new object. Supports BBcode, but HTML tags are not allowed Max content length: 12000 chars |
treat_as_html | integer API would accept “content” parameter in HTML format. Overrides “Accept HTML Content” global setting for one request Valid values: 0, 1 |
{- "content": "My first comment",
- "treat_as_html": 0
}
{- "success": {
- "attachments": [
- {
- "directUrl": "string",
- "icon": "string",
- "id": 0,
- "name": {
- "ext": "string",
- "full": "string",
- "short": "string"
}, - "url": "string"
}
], - "author": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "content": "string",
- "createdAgo": "string",
- "createdAt": "string",
- "createdAtPosix": 0,
- "id": 0,
- "is_best": 0,
- "objectId": 0,
- "ownership": "string",
- "replyToId": 0,
- "updatedAt": "string",
- "votes": {
- "amount": 0,
- "canVote": true,
- "isVoted": true,
- "plural": "string"
}
}
}
{- "success": {
- "attachments": [
- {
- "directUrl": "string",
- "icon": "string",
- "id": 0,
- "name": {
- "ext": "string",
- "full": "string",
- "short": "string"
}, - "url": "string"
}
], - "author": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "content": "string",
- "createdAgo": "string",
- "createdAt": "string",
- "createdAtPosix": 0,
- "id": 0,
- "is_best": 0,
- "objectId": 0,
- "ownership": "string",
- "replyToId": 0,
- "updatedAt": "string",
- "votes": {
- "amount": 0,
- "canVote": true,
- "isVoted": true,
- "plural": "string"
}
}
}
{- "success": {
- "attachments": [
- {
- "directUrl": "string",
- "icon": "string",
- "id": 0,
- "name": {
- "ext": "string",
- "full": "string",
- "short": "string"
}, - "url": "string"
}
], - "author": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "content": "string",
- "createdAgo": "string",
- "createdAt": "string",
- "createdAtPosix": 0,
- "id": 0,
- "is_best": 0,
- "objectId": 0,
- "ownership": "string",
- "replyToId": 0,
- "updatedAt": "string",
- "votes": {
- "amount": 0,
- "canVote": true,
- "isVoted": true,
- "plural": "string"
}
}
}
{- "success": {
- "attachments": [
- {
- "directUrl": "string",
- "icon": "string",
- "id": 0,
- "name": {
- "ext": "string",
- "full": "string",
- "short": "string"
}, - "url": "string"
}
], - "author": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "content": "string",
- "createdAgo": "string",
- "createdAt": "string",
- "createdAtPosix": 0,
- "id": 0,
- "is_best": 0,
- "objectId": 0,
- "ownership": "string",
- "replyToId": 0,
- "updatedAt": "string",
- "votes": {
- "amount": 0,
- "canVote": true,
- "isVoted": true,
- "plural": "string"
}
}
}
is_private | integer Default: 0 Enum: 0 1 Request returns private notes if this field is set to 1 |
page | integer If this parameter is not empty, the response will contain only limited number of comments for specified page. By default this method returns all comments. |
sort | string Default: "asc" Enum: "asc" "desc" Sort comments by creation date |
{- "success": [
- {
- "attachments": [
- {
- "directUrl": "string",
- "icon": "string",
- "id": 0,
- "name": {
- "ext": "string",
- "full": "string",
- "short": "string"
}, - "url": "string"
}
], - "author": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "content": "string",
- "createdAgo": "string",
- "createdAt": "string",
- "createdAtPosix": 0,
- "id": 0,
- "is_best": 0,
- "objectId": 0,
- "ownership": "string",
- "replyToId": 0,
- "updatedAt": "string",
- "votes": {
- "amount": 0,
- "canVote": true,
- "isVoted": true,
- "plural": "string"
}
}
]
}
ownership | string Example: ownership=feedback Filters the result by given ownership |
type | string Example: type=idea Filters the result by given object type |
[- {
- "color": {
- "background": "string",
- "text": "string"
}, - "id": 0,
- "isClosed": true,
- "isDefault": true,
- "isSystem": true,
- "order": 0,
- "ownership": "string",
- "slug": "string",
- "title": "string",
- "type": "string"
}
]
{- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}
string New valid “email” value. | |
full_name | string Not empty string containing user’s name. |
object Use name field to specify custom fields values Example {"property_12": "Support", "property_13": 4} | |
team_id | integer Valid team numeric identifier |
{- "email": "test@test.com",
- "full_name": "John Edwards",
- "properties": { },
- "team_id": 1
}
{- "success": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}
}
email required | string New valid “email” value |
full_name required | string Not empty string containing user’s name |
password | string User’s password |
object Use name field to specify custom fields values Example {"property_12": "Support", "property_13": 4} | |
team_id | integer Valid team numeric identifier |
{- "email": "test@test.com",
- "full_name": "John Edwards",
- "password": "securestring12345",
- "properties": { },
- "team_id": 1
}
{- "success": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}
}
method required | string Example: user Pass 'user' to save user's objects and replies |
{- "success": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}
}
id required | integer Example: 10 The numerical ID of the user |
{- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}
string New valid “email” value. | |
full_name | string Not empty string containing user’s name. |
object Use name field to specify custom fields values Example {"property_12": "Support", "property_13": 4} | |
team_id | integer Valid team numeric identifier |
{- "email": "test@test.com",
- "full_name": "John Edwards",
- "properties": { },
- "team_id": 1
}
{- "success": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}
}
page | integer Example: page=5 Specifies the page of results to retrieve |
count | integer Default: 20 Example: count=5 The number of potential user results to retrieve per page. This value has a maximum of 50 |
{- "currentPage": 0,
- "data": [
- {
- "attachments": [
- {
- "directUrl": "string",
- "icon": "string",
- "id": 0,
- "name": {
- "ext": "string",
- "full": "string",
- "short": "string"
}, - "url": "string"
}
], - "author": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "bestComment": {
- "attachments": [
- {
- "directUrl": "string",
- "icon": "string",
- "id": 0,
- "name": {
- "ext": "string",
- "full": "string",
- "short": "string"
}, - "url": "string"
}
], - "author": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "content": "string",
- "createdAgo": "string",
- "createdAt": "string",
- "createdAtPosix": 0,
- "id": 0,
- "is_best": 0,
- "objectId": 0,
- "ownership": "string",
- "replyToId": 0,
- "updatedAt": "string",
- "votes": {
- "amount": 0,
- "canVote": true,
- "isVoted": true,
- "plural": "string"
}
}, - "canBeCommented": true,
- "category": {
- "description": null,
- "forum": {
- "id": "string",
- "name": "string"
}, - "id": 0,
- "image": {
- "big": "string",
- "medium": "string",
- "small": "string"
}, - "isPrivate": true,
- "name": "string",
- "order": 0,
- "ownership": null,
- "parent_id": 0,
- "slug": "string",
- "type": null
}, - "commentedAt": "string",
- "commentsNum": 0,
- "completedBy": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "completedOn": "string",
- "content": "string",
- "createdAt": "string",
- "createdAtPosix": 0,
- "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "forum": {
- "id": "string",
- "name": "string"
}, - "id": 0,
- "isAbused": true,
- "isFeatured": true,
- "isPrivate": true,
- "isSubscribed": 0,
- "language": "string",
- "latestActivityPosix": 0,
- "links": [
- {
- "object_id": "string",
- "title": "string",
- "type": "string",
- "url": "string"
}
], - "ownership": "string",
- "parentObject": null,
- "recipients": [
- "string"
], - "responsible": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "score": 0,
- "scoreComment": "string",
- "scoreReason": "string",
- "slaDatePosix": 0,
- "slug": "string",
- "source": {
- "identifier": "string",
- "name": "string"
}, - "state": {
- "identifier": 0,
- "name": "string"
}, - "status": {
- "color": {
- "background": "string",
- "text": "string"
}, - "id": 0,
- "isClosed": true,
- "isDefault": true,
- "isSystem": true,
- "order": 0,
- "ownership": "string",
- "slug": "string",
- "title": "string",
- "type": "string"
}, - "tags": [
- "string"
], - "team": {
- "id": 0,
- "name": "string"
}, - "title": "string",
- "type": {
- "icon": {
- "big": "string",
- "small": "string"
}, - "order": 0,
- "slug": "string",
- "supports": {
- "comments": true,
- "negativeVote": true,
- "votes": true
}, - "title": {
- "plural": "string",
- "single": "string"
}
}, - "url": "string",
- "views": 0,
- "votes": {
- "all": 0,
- "canVote": true,
- "isVoted": true,
- "negative": 0,
- "plural": "string",
- "positive": 0
}
}
], - "firstPage": 0,
- "lastPage": 0,
- "nextPage": 0,
- "objectsPerPage": 0,
- "totalObjects": 0,
- "totalPages": 0
}
password required | string New valid “email” value |
{- "password": "securestring12345"
}
{- "success": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}
}
search | string Example: search=John, john@example.com The search phrase |
team | integer Example: team=1 Valid team numeric identifier |
sort | string Enum: "top_rated" "created_most" "commented_most" Sorts the result by given criteria |
string Example: email=john@example.com Search by email | |
phone | string Example: phone=4155550132 Search by phone |
page | integer Example: page=5 Specifies the page of results to retrieve |
count | integer Default: 20 Example: count=5 The number of potential user results to retrieve per page. This value has a maximum of 50 |
status | string Enum: "online" "offline" Search by user status. Only agents have status. |
{- "currentPage": 0,
- "data": [
- {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}
], - "firstPage": 0,
- "lastPage": 0,
- "nextPage": 0,
- "objectsPerPage": 0,
- "totalObjects": 0,
- "totalPages": 0
}
Array of objects Array of attachments | |
category_id | integer Valid category id to assign new object to Value 0 means no category |
content | string The content of a new object. Supports BBcode, but HTML tags are not allowed Max content length: 12000 charsRequired for feedback, announcements |
expire_select | string Allows to use object expiration date Value never means that announcement has no expiration date Valid only for announcements. Valid values: never, on_date |
expires_at | string Valid only for announcements and date should be in format dd.mm.yyyy required when expire_select parameter value is set to on_date |
force_author | string Allows to set object author manually Requires appropriate privilege Valid user id or any email address |
is_private | integer Allows to define object privacy Only for feedback and announcementsValid values: 0, 1 |
object_type required | string Enum: "ticket" "idea" "problem" "question" Valid object type |
ownership required | string Enum: "feedback" "helpdesk" Object belongs to a logical group |
object Use name field to specify custom fields values Example {"property_12": "Support", "property_13": 4} | |
responsible_id | integer Valid agent or administrator user id Value 0 means nobody |
tags | Array of strings Array of tags |
title required | string The title of a new object Max title length: 100 chars |
{- "attachments": [
- {
- "body": "iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAMAAADXqc3KAAAA.....==",
- "name": "call.png"
}
], - "category_id": 0,
- "content": "Here is the sense of my problem",
- "expire_select": "never",
- "expires_at": "15.06.2020",
- "force_author": "support@useresponse.com",
- "is_private": 0,
- "object_type": "ticket",
- "ownership": "helpdesk",
- "properties": { },
- "responsible_id": 10,
- "tags": [
- "string"
], - "title": "My first helpdesk record"
}
{- "success": {
- "attachments": [
- {
- "directUrl": "string",
- "icon": "string",
- "id": 0,
- "name": {
- "ext": "string",
- "full": "string",
- "short": "string"
}, - "url": "string"
}
], - "author": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "bestComment": {
- "attachments": [
- {
- "directUrl": "string",
- "icon": "string",
- "id": 0,
- "name": {
- "ext": "string",
- "full": "string",
- "short": "string"
}, - "url": "string"
}
], - "author": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "content": "string",
- "createdAgo": "string",
- "createdAt": "string",
- "createdAtPosix": 0,
- "id": 0,
- "is_best": 0,
- "objectId": 0,
- "ownership": "string",
- "replyToId": 0,
- "updatedAt": "string",
- "votes": {
- "amount": 0,
- "canVote": true,
- "isVoted": true,
- "plural": "string"
}
}, - "canBeCommented": true,
- "category": {
- "description": null,
- "forum": {
- "id": "string",
- "name": "string"
}, - "id": 0,
- "image": {
- "big": "string",
- "medium": "string",
- "small": "string"
}, - "isPrivate": true,
- "name": "string",
- "order": 0,
- "ownership": null,
- "parent_id": 0,
- "slug": "string",
- "type": null
}, - "commentedAt": "string",
- "commentsNum": 0,
- "completedBy": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "completedOn": "string",
- "content": "string",
- "createdAt": "string",
- "createdAtPosix": 0,
- "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "forum": {
- "id": "string",
- "name": "string"
}, - "id": 0,
- "isAbused": true,
- "isFeatured": true,
- "isPrivate": true,
- "isSubscribed": 0,
- "language": "string",
- "latestActivityPosix": 0,
- "links": [
- {
- "object_id": "string",
- "title": "string",
- "type": "string",
- "url": "string"
}
], - "ownership": "string",
- "parentObject": null,
- "recipients": [
- "string"
], - "responsible": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "score": 0,
- "scoreComment": "string",
- "scoreReason": "string",
- "slaDatePosix": 0,
- "slug": "string",
- "source": {
- "identifier": "string",
- "name": "string"
}, - "state": {
- "identifier": 0,
- "name": "string"
}, - "status": {
- "color": {
- "background": "string",
- "text": "string"
}, - "id": 0,
- "isClosed": true,
- "isDefault": true,
- "isSystem": true,
- "order": 0,
- "ownership": "string",
- "slug": "string",
- "title": "string",
- "type": "string"
}, - "tags": [
- "string"
], - "team": {
- "id": 0,
- "name": "string"
}, - "title": "string",
- "type": {
- "icon": {
- "big": "string",
- "small": "string"
}, - "order": 0,
- "slug": "string",
- "supports": {
- "comments": true,
- "negativeVote": true,
- "votes": true
}, - "title": {
- "plural": "string",
- "single": "string"
}
}, - "url": "string",
- "views": 0,
- "votes": {
- "all": 0,
- "canVote": true,
- "isVoted": true,
- "negative": 0,
- "plural": "string",
- "positive": 0
}
}
}
{- "success": {
- "attachments": [
- {
- "directUrl": "string",
- "icon": "string",
- "id": 0,
- "name": {
- "ext": "string",
- "full": "string",
- "short": "string"
}, - "url": "string"
}
], - "author": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "bestComment": {
- "attachments": [
- {
- "directUrl": "string",
- "icon": "string",
- "id": 0,
- "name": {
- "ext": "string",
- "full": "string",
- "short": "string"
}, - "url": "string"
}
], - "author": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "content": "string",
- "createdAgo": "string",
- "createdAt": "string",
- "createdAtPosix": 0,
- "id": 0,
- "is_best": 0,
- "objectId": 0,
- "ownership": "string",
- "replyToId": 0,
- "updatedAt": "string",
- "votes": {
- "amount": 0,
- "canVote": true,
- "isVoted": true,
- "plural": "string"
}
}, - "canBeCommented": true,
- "category": {
- "description": null,
- "forum": {
- "id": "string",
- "name": "string"
}, - "id": 0,
- "image": {
- "big": "string",
- "medium": "string",
- "small": "string"
}, - "isPrivate": true,
- "name": "string",
- "order": 0,
- "ownership": null,
- "parent_id": 0,
- "slug": "string",
- "type": null
}, - "commentedAt": "string",
- "commentsNum": 0,
- "completedBy": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "completedOn": "string",
- "content": "string",
- "createdAt": "string",
- "createdAtPosix": 0,
- "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "forum": {
- "id": "string",
- "name": "string"
}, - "id": 0,
- "isAbused": true,
- "isFeatured": true,
- "isPrivate": true,
- "isSubscribed": 0,
- "language": "string",
- "latestActivityPosix": 0,
- "links": [
- {
- "object_id": "string",
- "title": "string",
- "type": "string",
- "url": "string"
}
], - "ownership": "string",
- "parentObject": null,
- "recipients": [
- "string"
], - "responsible": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "score": 0,
- "scoreComment": "string",
- "scoreReason": "string",
- "slaDatePosix": 0,
- "slug": "string",
- "source": {
- "identifier": "string",
- "name": "string"
}, - "state": {
- "identifier": 0,
- "name": "string"
}, - "status": {
- "color": {
- "background": "string",
- "text": "string"
}, - "id": 0,
- "isClosed": true,
- "isDefault": true,
- "isSystem": true,
- "order": 0,
- "ownership": "string",
- "slug": "string",
- "title": "string",
- "type": "string"
}, - "tags": [
- "string"
], - "team": {
- "id": 0,
- "name": "string"
}, - "title": "string",
- "type": {
- "icon": {
- "big": "string",
- "small": "string"
}, - "order": 0,
- "slug": "string",
- "supports": {
- "comments": true,
- "negativeVote": true,
- "votes": true
}, - "title": {
- "plural": "string",
- "single": "string"
}
}, - "url": "string",
- "views": 0,
- "votes": {
- "all": 0,
- "canVote": true,
- "isVoted": true,
- "negative": 0,
- "plural": "string",
- "positive": 0
}
}
}
id required | integer Example: 10 The numerical ID of the object |
{- "attachments": [
- {
- "directUrl": "string",
- "icon": "string",
- "id": 0,
- "name": {
- "ext": "string",
- "full": "string",
- "short": "string"
}, - "url": "string"
}
], - "author": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "bestComment": {
- "attachments": [
- {
- "directUrl": "string",
- "icon": "string",
- "id": 0,
- "name": {
- "ext": "string",
- "full": "string",
- "short": "string"
}, - "url": "string"
}
], - "author": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "content": "string",
- "createdAgo": "string",
- "createdAt": "string",
- "createdAtPosix": 0,
- "id": 0,
- "is_best": 0,
- "objectId": 0,
- "ownership": "string",
- "replyToId": 0,
- "updatedAt": "string",
- "votes": {
- "amount": 0,
- "canVote": true,
- "isVoted": true,
- "plural": "string"
}
}, - "canBeCommented": true,
- "category": {
- "description": null,
- "forum": {
- "id": "string",
- "name": "string"
}, - "id": 0,
- "image": {
- "big": "string",
- "medium": "string",
- "small": "string"
}, - "isPrivate": true,
- "name": "string",
- "order": 0,
- "ownership": null,
- "parent_id": 0,
- "slug": "string",
- "type": null
}, - "commentedAt": "string",
- "commentsNum": 0,
- "completedBy": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "completedOn": "string",
- "content": "string",
- "createdAt": "string",
- "createdAtPosix": 0,
- "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "forum": {
- "id": "string",
- "name": "string"
}, - "id": 0,
- "isAbused": true,
- "isFeatured": true,
- "isPrivate": true,
- "isSubscribed": 0,
- "language": "string",
- "latestActivityPosix": 0,
- "links": [
- {
- "object_id": "string",
- "title": "string",
- "type": "string",
- "url": "string"
}
], - "ownership": "string",
- "parentObject": null,
- "recipients": [
- "string"
], - "responsible": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "score": 0,
- "scoreComment": "string",
- "scoreReason": "string",
- "slaDatePosix": 0,
- "slug": "string",
- "source": {
- "identifier": "string",
- "name": "string"
}, - "state": {
- "identifier": 0,
- "name": "string"
}, - "status": {
- "color": {
- "background": "string",
- "text": "string"
}, - "id": 0,
- "isClosed": true,
- "isDefault": true,
- "isSystem": true,
- "order": 0,
- "ownership": "string",
- "slug": "string",
- "title": "string",
- "type": "string"
}, - "tags": [
- "string"
], - "team": {
- "id": 0,
- "name": "string"
}, - "title": "string",
- "type": {
- "icon": {
- "big": "string",
- "small": "string"
}, - "order": 0,
- "slug": "string",
- "supports": {
- "comments": true,
- "negativeVote": true,
- "votes": true
}, - "title": {
- "plural": "string",
- "single": "string"
}
}, - "url": "string",
- "views": 0,
- "votes": {
- "all": 0,
- "canVote": true,
- "isVoted": true,
- "negative": 0,
- "plural": "string",
- "positive": 0
}
}
Array of objects Array of attachments | |
category_id | integer Valid category id to assign new object to Value 0 means no category |
content | string The content of a new object. Supports BBcode, but HTML tags are not allowed Max content length: 12000 charsRequired for feedback, announcements |
expire_select | string Allows to use object expiration date Value never means that announcement has no expiration date Valid only for announcements. Valid values: never, on_date |
expires_at | string Valid only for announcements and date should be in format dd.mm.yyyy required when expire_select parameter value is set to on_date |
force_author | string Allows to set object author manually Requires appropriate privilege Valid user id or any email address |
is_private | integer Allows to define object privacy Only for feedback and announcementsValid values: 0, 1 |
object_type | string Valid object type |
object Use name field to specify custom fields values Example {"property_12": "Support", "property_13": 4} | |
responsible_id | integer Valid agent or administrator user id Value 0 means nobody |
status_id | integer Valid status id. Id can be taken from statuses.json |
tags | Array of strings Array of tags |
title | string The title of a new object Max title length: 100 chars |
{- "attachments": [
- {
- "body": "iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAMAAADXqc3KAAAA.....==",
- "name": "call.png"
}
], - "category_id": 0,
- "content": "Here is the sense of my problem",
- "expire_select": "never",
- "expires_at": "15.06.2020",
- "force_author": "support@useresponse.com",
- "is_private": 0,
- "object_type": "ticket",
- "properties": { },
- "responsible_id": 10,
- "status_id": 1,
- "tags": [
- "string"
], - "title": "My first helpdesk record"
}
{- "success": {
- "attachments": [
- {
- "directUrl": "string",
- "icon": "string",
- "id": 0,
- "name": {
- "ext": "string",
- "full": "string",
- "short": "string"
}, - "url": "string"
}
], - "author": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "bestComment": {
- "attachments": [
- {
- "directUrl": "string",
- "icon": "string",
- "id": 0,
- "name": {
- "ext": "string",
- "full": "string",
- "short": "string"
}, - "url": "string"
}
], - "author": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "content": "string",
- "createdAgo": "string",
- "createdAt": "string",
- "createdAtPosix": 0,
- "id": 0,
- "is_best": 0,
- "objectId": 0,
- "ownership": "string",
- "replyToId": 0,
- "updatedAt": "string",
- "votes": {
- "amount": 0,
- "canVote": true,
- "isVoted": true,
- "plural": "string"
}
}, - "canBeCommented": true,
- "category": {
- "description": null,
- "forum": {
- "id": "string",
- "name": "string"
}, - "id": 0,
- "image": {
- "big": "string",
- "medium": "string",
- "small": "string"
}, - "isPrivate": true,
- "name": "string",
- "order": 0,
- "ownership": null,
- "parent_id": 0,
- "slug": "string",
- "type": null
}, - "commentedAt": "string",
- "commentsNum": 0,
- "completedBy": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "completedOn": "string",
- "content": "string",
- "createdAt": "string",
- "createdAtPosix": 0,
- "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "forum": {
- "id": "string",
- "name": "string"
}, - "id": 0,
- "isAbused": true,
- "isFeatured": true,
- "isPrivate": true,
- "isSubscribed": 0,
- "language": "string",
- "latestActivityPosix": 0,
- "links": [
- {
- "object_id": "string",
- "title": "string",
- "type": "string",
- "url": "string"
}
], - "ownership": "string",
- "parentObject": null,
- "recipients": [
- "string"
], - "responsible": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "score": 0,
- "scoreComment": "string",
- "scoreReason": "string",
- "slaDatePosix": 0,
- "slug": "string",
- "source": {
- "identifier": "string",
- "name": "string"
}, - "state": {
- "identifier": 0,
- "name": "string"
}, - "status": {
- "color": {
- "background": "string",
- "text": "string"
}, - "id": 0,
- "isClosed": true,
- "isDefault": true,
- "isSystem": true,
- "order": 0,
- "ownership": "string",
- "slug": "string",
- "title": "string",
- "type": "string"
}, - "tags": [
- "string"
], - "team": {
- "id": 0,
- "name": "string"
}, - "title": "string",
- "type": {
- "icon": {
- "big": "string",
- "small": "string"
}, - "order": 0,
- "slug": "string",
- "supports": {
- "comments": true,
- "negativeVote": true,
- "votes": true
}, - "title": {
- "plural": "string",
- "single": "string"
}
}, - "url": "string",
- "views": 0,
- "votes": {
- "all": 0,
- "canVote": true,
- "isVoted": true,
- "negative": 0,
- "plural": "string",
- "positive": 0
}
}
}
{- "success": {
- "attachments": [
- {
- "directUrl": "string",
- "icon": "string",
- "id": 0,
- "name": {
- "ext": "string",
- "full": "string",
- "short": "string"
}, - "url": "string"
}
], - "author": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "bestComment": {
- "attachments": [
- {
- "directUrl": "string",
- "icon": "string",
- "id": 0,
- "name": {
- "ext": "string",
- "full": "string",
- "short": "string"
}, - "url": "string"
}
], - "author": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "content": "string",
- "createdAgo": "string",
- "createdAt": "string",
- "createdAtPosix": 0,
- "id": 0,
- "is_best": 0,
- "objectId": 0,
- "ownership": "string",
- "replyToId": 0,
- "updatedAt": "string",
- "votes": {
- "amount": 0,
- "canVote": true,
- "isVoted": true,
- "plural": "string"
}
}, - "canBeCommented": true,
- "category": {
- "description": null,
- "forum": {
- "id": "string",
- "name": "string"
}, - "id": 0,
- "image": {
- "big": "string",
- "medium": "string",
- "small": "string"
}, - "isPrivate": true,
- "name": "string",
- "order": 0,
- "ownership": null,
- "parent_id": 0,
- "slug": "string",
- "type": null
}, - "commentedAt": "string",
- "commentsNum": 0,
- "completedBy": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "completedOn": "string",
- "content": "string",
- "createdAt": "string",
- "createdAtPosix": 0,
- "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "forum": {
- "id": "string",
- "name": "string"
}, - "id": 0,
- "isAbused": true,
- "isFeatured": true,
- "isPrivate": true,
- "isSubscribed": 0,
- "language": "string",
- "latestActivityPosix": 0,
- "links": [
- {
- "object_id": "string",
- "title": "string",
- "type": "string",
- "url": "string"
}
], - "ownership": "string",
- "parentObject": null,
- "recipients": [
- "string"
], - "responsible": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "score": 0,
- "scoreComment": "string",
- "scoreReason": "string",
- "slaDatePosix": 0,
- "slug": "string",
- "source": {
- "identifier": "string",
- "name": "string"
}, - "state": {
- "identifier": 0,
- "name": "string"
}, - "status": {
- "color": {
- "background": "string",
- "text": "string"
}, - "id": 0,
- "isClosed": true,
- "isDefault": true,
- "isSystem": true,
- "order": 0,
- "ownership": "string",
- "slug": "string",
- "title": "string",
- "type": "string"
}, - "tags": [
- "string"
], - "team": {
- "id": 0,
- "name": "string"
}, - "title": "string",
- "type": {
- "icon": {
- "big": "string",
- "small": "string"
}, - "order": 0,
- "slug": "string",
- "supports": {
- "comments": true,
- "negativeVote": true,
- "votes": true
}, - "title": {
- "plural": "string",
- "single": "string"
}
}, - "url": "string",
- "views": 0,
- "votes": {
- "all": 0,
- "canVote": true,
- "isVoted": true,
- "negative": 0,
- "plural": "string",
- "positive": 0
}
}
}
name required | string Example: screenshot.jpg The name of the new file with allowed extension |
Post request body should contain raw file content
"string"
{- "success": {
- "attachments": [
- {
- "directUrl": "string",
- "icon": "string",
- "id": 0,
- "name": {
- "ext": "string",
- "full": "string",
- "short": "string"
}, - "url": "string"
}
], - "author": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "bestComment": {
- "attachments": [
- {
- "directUrl": "string",
- "icon": "string",
- "id": 0,
- "name": {
- "ext": "string",
- "full": "string",
- "short": "string"
}, - "url": "string"
}
], - "author": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "content": "string",
- "createdAgo": "string",
- "createdAt": "string",
- "createdAtPosix": 0,
- "id": 0,
- "is_best": 0,
- "objectId": 0,
- "ownership": "string",
- "replyToId": 0,
- "updatedAt": "string",
- "votes": {
- "amount": 0,
- "canVote": true,
- "isVoted": true,
- "plural": "string"
}
}, - "canBeCommented": true,
- "category": {
- "description": null,
- "forum": {
- "id": "string",
- "name": "string"
}, - "id": 0,
- "image": {
- "big": "string",
- "medium": "string",
- "small": "string"
}, - "isPrivate": true,
- "name": "string",
- "order": 0,
- "ownership": null,
- "parent_id": 0,
- "slug": "string",
- "type": null
}, - "commentedAt": "string",
- "commentsNum": 0,
- "completedBy": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "completedOn": "string",
- "content": "string",
- "createdAt": "string",
- "createdAtPosix": 0,
- "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "forum": {
- "id": "string",
- "name": "string"
}, - "id": 0,
- "isAbused": true,
- "isFeatured": true,
- "isPrivate": true,
- "isSubscribed": 0,
- "language": "string",
- "latestActivityPosix": 0,
- "links": [
- {
- "object_id": "string",
- "title": "string",
- "type": "string",
- "url": "string"
}
], - "ownership": "string",
- "parentObject": null,
- "recipients": [
- "string"
], - "responsible": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "score": 0,
- "scoreComment": "string",
- "scoreReason": "string",
- "slaDatePosix": 0,
- "slug": "string",
- "source": {
- "identifier": "string",
- "name": "string"
}, - "state": {
- "identifier": 0,
- "name": "string"
}, - "status": {
- "color": {
- "background": "string",
- "text": "string"
}, - "id": 0,
- "isClosed": true,
- "isDefault": true,
- "isSystem": true,
- "order": 0,
- "ownership": "string",
- "slug": "string",
- "title": "string",
- "type": "string"
}, - "tags": [
- "string"
], - "team": {
- "id": 0,
- "name": "string"
}, - "title": "string",
- "type": {
- "icon": {
- "big": "string",
- "small": "string"
}, - "order": 0,
- "slug": "string",
- "supports": {
- "comments": true,
- "negativeVote": true,
- "votes": true
}, - "title": {
- "plural": "string",
- "single": "string"
}
}, - "url": "string",
- "views": 0,
- "votes": {
- "all": 0,
- "canVote": true,
- "isVoted": true,
- "negative": 0,
- "plural": "string",
- "positive": 0
}
}
}
{- "success": {
- "attachments": [
- {
- "directUrl": "string",
- "icon": "string",
- "id": 0,
- "name": {
- "ext": "string",
- "full": "string",
- "short": "string"
}, - "url": "string"
}
], - "author": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "bestComment": {
- "attachments": [
- {
- "directUrl": "string",
- "icon": "string",
- "id": 0,
- "name": {
- "ext": "string",
- "full": "string",
- "short": "string"
}, - "url": "string"
}
], - "author": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "content": "string",
- "createdAgo": "string",
- "createdAt": "string",
- "createdAtPosix": 0,
- "id": 0,
- "is_best": 0,
- "objectId": 0,
- "ownership": "string",
- "replyToId": 0,
- "updatedAt": "string",
- "votes": {
- "amount": 0,
- "canVote": true,
- "isVoted": true,
- "plural": "string"
}
}, - "canBeCommented": true,
- "category": {
- "description": null,
- "forum": {
- "id": "string",
- "name": "string"
}, - "id": 0,
- "image": {
- "big": "string",
- "medium": "string",
- "small": "string"
}, - "isPrivate": true,
- "name": "string",
- "order": 0,
- "ownership": null,
- "parent_id": 0,
- "slug": "string",
- "type": null
}, - "commentedAt": "string",
- "commentsNum": 0,
- "completedBy": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "completedOn": "string",
- "content": "string",
- "createdAt": "string",
- "createdAtPosix": 0,
- "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "forum": {
- "id": "string",
- "name": "string"
}, - "id": 0,
- "isAbused": true,
- "isFeatured": true,
- "isPrivate": true,
- "isSubscribed": 0,
- "language": "string",
- "latestActivityPosix": 0,
- "links": [
- {
- "object_id": "string",
- "title": "string",
- "type": "string",
- "url": "string"
}
], - "ownership": "string",
- "parentObject": null,
- "recipients": [
- "string"
], - "responsible": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "score": 0,
- "scoreComment": "string",
- "scoreReason": "string",
- "slaDatePosix": 0,
- "slug": "string",
- "source": {
- "identifier": "string",
- "name": "string"
}, - "state": {
- "identifier": 0,
- "name": "string"
}, - "status": {
- "color": {
- "background": "string",
- "text": "string"
}, - "id": 0,
- "isClosed": true,
- "isDefault": true,
- "isSystem": true,
- "order": 0,
- "ownership": "string",
- "slug": "string",
- "title": "string",
- "type": "string"
}, - "tags": [
- "string"
], - "team": {
- "id": 0,
- "name": "string"
}, - "title": "string",
- "type": {
- "icon": {
- "big": "string",
- "small": "string"
}, - "order": 0,
- "slug": "string",
- "supports": {
- "comments": true,
- "negativeVote": true,
- "votes": true
}, - "title": {
- "plural": "string",
- "single": "string"
}
}, - "url": "string",
- "views": 0,
- "votes": {
- "all": 0,
- "canVote": true,
- "isVoted": true,
- "negative": 0,
- "plural": "string",
- "positive": 0
}
}
}
user_id | integer Example: user_id=6 If user_id parameter is not defined current user will be used instead |
{- "success": {
- "attachments": [
- {
- "directUrl": "string",
- "icon": "string",
- "id": 0,
- "name": {
- "ext": "string",
- "full": "string",
- "short": "string"
}, - "url": "string"
}
], - "author": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "bestComment": {
- "attachments": [
- {
- "directUrl": "string",
- "icon": "string",
- "id": 0,
- "name": {
- "ext": "string",
- "full": "string",
- "short": "string"
}, - "url": "string"
}
], - "author": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "content": "string",
- "createdAgo": "string",
- "createdAt": "string",
- "createdAtPosix": 0,
- "id": 0,
- "is_best": 0,
- "objectId": 0,
- "ownership": "string",
- "replyToId": 0,
- "updatedAt": "string",
- "votes": {
- "amount": 0,
- "canVote": true,
- "isVoted": true,
- "plural": "string"
}
}, - "canBeCommented": true,
- "category": {
- "description": null,
- "forum": {
- "id": "string",
- "name": "string"
}, - "id": 0,
- "image": {
- "big": "string",
- "medium": "string",
- "small": "string"
}, - "isPrivate": true,
- "name": "string",
- "order": 0,
- "ownership": null,
- "parent_id": 0,
- "slug": "string",
- "type": null
}, - "commentedAt": "string",
- "commentsNum": 0,
- "completedBy": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "completedOn": "string",
- "content": "string",
- "createdAt": "string",
- "createdAtPosix": 0,
- "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "forum": {
- "id": "string",
- "name": "string"
}, - "id": 0,
- "isAbused": true,
- "isFeatured": true,
- "isPrivate": true,
- "isSubscribed": 0,
- "language": "string",
- "latestActivityPosix": 0,
- "links": [
- {
- "object_id": "string",
- "title": "string",
- "type": "string",
- "url": "string"
}
], - "ownership": "string",
- "parentObject": null,
- "recipients": [
- "string"
], - "responsible": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "score": 0,
- "scoreComment": "string",
- "scoreReason": "string",
- "slaDatePosix": 0,
- "slug": "string",
- "source": {
- "identifier": "string",
- "name": "string"
}, - "state": {
- "identifier": 0,
- "name": "string"
}, - "status": {
- "color": {
- "background": "string",
- "text": "string"
}, - "id": 0,
- "isClosed": true,
- "isDefault": true,
- "isSystem": true,
- "order": 0,
- "ownership": "string",
- "slug": "string",
- "title": "string",
- "type": "string"
}, - "tags": [
- "string"
], - "team": {
- "id": 0,
- "name": "string"
}, - "title": "string",
- "type": {
- "icon": {
- "big": "string",
- "small": "string"
}, - "order": 0,
- "slug": "string",
- "supports": {
- "comments": true,
- "negativeVote": true,
- "votes": true
}, - "title": {
- "plural": "string",
- "single": "string"
}
}, - "url": "string",
- "views": 0,
- "votes": {
- "all": 0,
- "canVote": true,
- "isVoted": true,
- "negative": 0,
- "plural": "string",
- "positive": 0
}
}
}
{- "success": {
- "attachments": [
- {
- "directUrl": "string",
- "icon": "string",
- "id": 0,
- "name": {
- "ext": "string",
- "full": "string",
- "short": "string"
}, - "url": "string"
}
], - "author": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "bestComment": {
- "attachments": [
- {
- "directUrl": "string",
- "icon": "string",
- "id": 0,
- "name": {
- "ext": "string",
- "full": "string",
- "short": "string"
}, - "url": "string"
}
], - "author": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "content": "string",
- "createdAgo": "string",
- "createdAt": "string",
- "createdAtPosix": 0,
- "id": 0,
- "is_best": 0,
- "objectId": 0,
- "ownership": "string",
- "replyToId": 0,
- "updatedAt": "string",
- "votes": {
- "amount": 0,
- "canVote": true,
- "isVoted": true,
- "plural": "string"
}
}, - "canBeCommented": true,
- "category": {
- "description": null,
- "forum": {
- "id": "string",
- "name": "string"
}, - "id": 0,
- "image": {
- "big": "string",
- "medium": "string",
- "small": "string"
}, - "isPrivate": true,
- "name": "string",
- "order": 0,
- "ownership": null,
- "parent_id": 0,
- "slug": "string",
- "type": null
}, - "commentedAt": "string",
- "commentsNum": 0,
- "completedBy": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "completedOn": "string",
- "content": "string",
- "createdAt": "string",
- "createdAtPosix": 0,
- "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "forum": {
- "id": "string",
- "name": "string"
}, - "id": 0,
- "isAbused": true,
- "isFeatured": true,
- "isPrivate": true,
- "isSubscribed": 0,
- "language": "string",
- "latestActivityPosix": 0,
- "links": [
- {
- "object_id": "string",
- "title": "string",
- "type": "string",
- "url": "string"
}
], - "ownership": "string",
- "parentObject": null,
- "recipients": [
- "string"
], - "responsible": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "score": 0,
- "scoreComment": "string",
- "scoreReason": "string",
- "slaDatePosix": 0,
- "slug": "string",
- "source": {
- "identifier": "string",
- "name": "string"
}, - "state": {
- "identifier": 0,
- "name": "string"
}, - "status": {
- "color": {
- "background": "string",
- "text": "string"
}, - "id": 0,
- "isClosed": true,
- "isDefault": true,
- "isSystem": true,
- "order": 0,
- "ownership": "string",
- "slug": "string",
- "title": "string",
- "type": "string"
}, - "tags": [
- "string"
], - "team": {
- "id": 0,
- "name": "string"
}, - "title": "string",
- "type": {
- "icon": {
- "big": "string",
- "small": "string"
}, - "order": 0,
- "slug": "string",
- "supports": {
- "comments": true,
- "negativeVote": true,
- "votes": true
}, - "title": {
- "plural": "string",
- "single": "string"
}
}, - "url": "string",
- "views": 0,
- "votes": {
- "all": 0,
- "canVote": true,
- "isVoted": true,
- "negative": 0,
- "plural": "string",
- "positive": 0
}
}
}
user_id | integer Example: user_id=6 If user_id parameter is not defined current user will be used instead |
{- "success": {
- "attachments": [
- {
- "directUrl": "string",
- "icon": "string",
- "id": 0,
- "name": {
- "ext": "string",
- "full": "string",
- "short": "string"
}, - "url": "string"
}
], - "author": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "bestComment": {
- "attachments": [
- {
- "directUrl": "string",
- "icon": "string",
- "id": 0,
- "name": {
- "ext": "string",
- "full": "string",
- "short": "string"
}, - "url": "string"
}
], - "author": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "content": "string",
- "createdAgo": "string",
- "createdAt": "string",
- "createdAtPosix": 0,
- "id": 0,
- "is_best": 0,
- "objectId": 0,
- "ownership": "string",
- "replyToId": 0,
- "updatedAt": "string",
- "votes": {
- "amount": 0,
- "canVote": true,
- "isVoted": true,
- "plural": "string"
}
}, - "canBeCommented": true,
- "category": {
- "description": null,
- "forum": {
- "id": "string",
- "name": "string"
}, - "id": 0,
- "image": {
- "big": "string",
- "medium": "string",
- "small": "string"
}, - "isPrivate": true,
- "name": "string",
- "order": 0,
- "ownership": null,
- "parent_id": 0,
- "slug": "string",
- "type": null
}, - "commentedAt": "string",
- "commentsNum": 0,
- "completedBy": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "completedOn": "string",
- "content": "string",
- "createdAt": "string",
- "createdAtPosix": 0,
- "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "forum": {
- "id": "string",
- "name": "string"
}, - "id": 0,
- "isAbused": true,
- "isFeatured": true,
- "isPrivate": true,
- "isSubscribed": 0,
- "language": "string",
- "latestActivityPosix": 0,
- "links": [
- {
- "object_id": "string",
- "title": "string",
- "type": "string",
- "url": "string"
}
], - "ownership": "string",
- "parentObject": null,
- "recipients": [
- "string"
], - "responsible": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "score": 0,
- "scoreComment": "string",
- "scoreReason": "string",
- "slaDatePosix": 0,
- "slug": "string",
- "source": {
- "identifier": "string",
- "name": "string"
}, - "state": {
- "identifier": 0,
- "name": "string"
}, - "status": {
- "color": {
- "background": "string",
- "text": "string"
}, - "id": 0,
- "isClosed": true,
- "isDefault": true,
- "isSystem": true,
- "order": 0,
- "ownership": "string",
- "slug": "string",
- "title": "string",
- "type": "string"
}, - "tags": [
- "string"
], - "team": {
- "id": 0,
- "name": "string"
}, - "title": "string",
- "type": {
- "icon": {
- "big": "string",
- "small": "string"
}, - "order": 0,
- "slug": "string",
- "supports": {
- "comments": true,
- "negativeVote": true,
- "votes": true
}, - "title": {
- "plural": "string",
- "single": "string"
}
}, - "url": "string",
- "views": 0,
- "votes": {
- "all": 0,
- "canVote": true,
- "isVoted": true,
- "negative": 0,
- "plural": "string",
- "positive": 0
}
}
}
value required | string Enum: "up" "down" "revert" Vote action |
{- "success": {
- "attachments": [
- {
- "directUrl": "string",
- "icon": "string",
- "id": 0,
- "name": {
- "ext": "string",
- "full": "string",
- "short": "string"
}, - "url": "string"
}
], - "author": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "bestComment": {
- "attachments": [
- {
- "directUrl": "string",
- "icon": "string",
- "id": 0,
- "name": {
- "ext": "string",
- "full": "string",
- "short": "string"
}, - "url": "string"
}
], - "author": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "content": "string",
- "createdAgo": "string",
- "createdAt": "string",
- "createdAtPosix": 0,
- "id": 0,
- "is_best": 0,
- "objectId": 0,
- "ownership": "string",
- "replyToId": 0,
- "updatedAt": "string",
- "votes": {
- "amount": 0,
- "canVote": true,
- "isVoted": true,
- "plural": "string"
}
}, - "canBeCommented": true,
- "category": {
- "description": null,
- "forum": {
- "id": "string",
- "name": "string"
}, - "id": 0,
- "image": {
- "big": "string",
- "medium": "string",
- "small": "string"
}, - "isPrivate": true,
- "name": "string",
- "order": 0,
- "ownership": null,
- "parent_id": 0,
- "slug": "string",
- "type": null
}, - "commentedAt": "string",
- "commentsNum": 0,
- "completedBy": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "completedOn": "string",
- "content": "string",
- "createdAt": "string",
- "createdAtPosix": 0,
- "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "forum": {
- "id": "string",
- "name": "string"
}, - "id": 0,
- "isAbused": true,
- "isFeatured": true,
- "isPrivate": true,
- "isSubscribed": 0,
- "language": "string",
- "latestActivityPosix": 0,
- "links": [
- {
- "object_id": "string",
- "title": "string",
- "type": "string",
- "url": "string"
}
], - "ownership": "string",
- "parentObject": null,
- "recipients": [
- "string"
], - "responsible": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "score": 0,
- "scoreComment": "string",
- "scoreReason": "string",
- "slaDatePosix": 0,
- "slug": "string",
- "source": {
- "identifier": "string",
- "name": "string"
}, - "state": {
- "identifier": 0,
- "name": "string"
}, - "status": {
- "color": {
- "background": "string",
- "text": "string"
}, - "id": 0,
- "isClosed": true,
- "isDefault": true,
- "isSystem": true,
- "order": 0,
- "ownership": "string",
- "slug": "string",
- "title": "string",
- "type": "string"
}, - "tags": [
- "string"
], - "team": {
- "id": 0,
- "name": "string"
}, - "title": "string",
- "type": {
- "icon": {
- "big": "string",
- "small": "string"
}, - "order": 0,
- "slug": "string",
- "supports": {
- "comments": true,
- "negativeVote": true,
- "votes": true
}, - "title": {
- "plural": "string",
- "single": "string"
}
}, - "url": "string",
- "views": 0,
- "votes": {
- "all": 0,
- "canVote": true,
- "isVoted": true,
- "negative": 0,
- "plural": "string",
- "positive": 0
}
}
}
text | string Example: text=SAML The search phrase |
ownership | string Example: ownership=feedback Object belongs to a logical group |
status | string Example: status=solved Filters the result by given status |
category_id | integer Example: category_id=10 Filters the result by given category id |
date | string Enum: "today" "yesterday" "this_week" "last_week" "this_month" "last_month" Filters the result by given date range |
type | string Example: type=problem Filters the result by given object type |
authorId | integer Example: authorId=10 Filters the result by given user id |
sort | string Enum: "new" "updated" "new_updated" "popular" "trending" Sorts the result by given filter. |
count | integer Default: 20 Example: count=5 The number of object (for each ownership) to retrieve per page |
{- "success": {
- "currentPage": 0,
- "data": [
- {
- "attachments": [
- {
- "directUrl": "string",
- "icon": "string",
- "id": 0,
- "name": {
- "ext": "string",
- "full": "string",
- "short": "string"
}, - "url": "string"
}
], - "author": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "bestComment": {
- "attachments": [
- {
- "directUrl": "string",
- "icon": "string",
- "id": 0,
- "name": {
- "ext": "string",
- "full": "string",
- "short": "string"
}, - "url": "string"
}
], - "author": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "content": "string",
- "createdAgo": "string",
- "createdAt": "string",
- "createdAtPosix": 0,
- "id": 0,
- "is_best": 0,
- "objectId": 0,
- "ownership": "string",
- "replyToId": 0,
- "updatedAt": "string",
- "votes": {
- "amount": 0,
- "canVote": true,
- "isVoted": true,
- "plural": "string"
}
}, - "canBeCommented": true,
- "category": {
- "description": null,
- "forum": {
- "id": "string",
- "name": "string"
}, - "id": 0,
- "image": {
- "big": "string",
- "medium": "string",
- "small": "string"
}, - "isPrivate": true,
- "name": "string",
- "order": 0,
- "ownership": null,
- "parent_id": 0,
- "slug": "string",
- "type": null
}, - "commentedAt": "string",
- "commentsNum": 0,
- "completedBy": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "completedOn": "string",
- "content": "string",
- "createdAt": "string",
- "createdAtPosix": 0,
- "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "forum": {
- "id": "string",
- "name": "string"
}, - "id": 0,
- "isAbused": true,
- "isFeatured": true,
- "isPrivate": true,
- "isSubscribed": 0,
- "language": "string",
- "latestActivityPosix": 0,
- "links": [
- {
- "object_id": "string",
- "title": "string",
- "type": "string",
- "url": "string"
}
], - "ownership": "string",
- "parentObject": null,
- "recipients": [
- "string"
], - "responsible": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "score": 0,
- "scoreComment": "string",
- "scoreReason": "string",
- "slaDatePosix": 0,
- "slug": "string",
- "source": {
- "identifier": "string",
- "name": "string"
}, - "state": {
- "identifier": 0,
- "name": "string"
}, - "status": {
- "color": {
- "background": "string",
- "text": "string"
}, - "id": 0,
- "isClosed": true,
- "isDefault": true,
- "isSystem": true,
- "order": 0,
- "ownership": "string",
- "slug": "string",
- "title": "string",
- "type": "string"
}, - "tags": [
- "string"
], - "team": {
- "id": 0,
- "name": "string"
}, - "title": "string",
- "type": {
- "icon": {
- "big": "string",
- "small": "string"
}, - "order": 0,
- "slug": "string",
- "supports": {
- "comments": true,
- "negativeVote": true,
- "votes": true
}, - "title": {
- "plural": "string",
- "single": "string"
}
}, - "url": "string",
- "views": 0,
- "votes": {
- "all": 0,
- "canVote": true,
- "isVoted": true,
- "negative": 0,
- "plural": "string",
- "positive": 0
}
}
], - "firstPage": 0,
- "lastPage": 0,
- "nextPage": 0,
- "objectsPerPage": 0,
- "totalObjects": 0,
- "totalPages": 0
}
}
text | string Example: text=SAML The search phrase |
status | string Default: "all-active" Example: status=all, opened, on_hold, in_progress, awaiting_reply, all-active, completed Filters the result by given status |
date | string Enum: "today" "yesterday" "this_week" "last_week" "this_month" "last_month" Filters the result by given date range |
completed_on | string Enum: "today" "yesterday" "this_week" "last_week" "this_month" "last_month" Filters the result by given completed range |
authorId | integer Example: authorId=10 Filters the result by given user id |
authorEmail | string Example: authorEmail=support@useresponse.com Filters the result by given user email |
responsible_id | integer Example: responsible_id=1 Filters the result by given responsible id |
forum_id | integer Example: forum_id=1 Filters the result by given forum id. Forum ids can be taken from /forums.json |
completed_by | integer Example: completed_by=1 Filters the completed tickets by given user id |
sort | string Enum: "new" "updated" "new_updated" "popular" "trending" Sorts the result by given filter. |
page | integer Example: page=3 Specifies the page of results to retrieve |
count | integer Default: 20 Example: count=5 The number of object (for each ownership) to retrieve per page |
{- "success": {
- "currentPage": 0,
- "data": [
- {
- "attachments": [
- {
- "directUrl": "string",
- "icon": "string",
- "id": 0,
- "name": {
- "ext": "string",
- "full": "string",
- "short": "string"
}, - "url": "string"
}
], - "author": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "bestComment": {
- "attachments": [
- {
- "directUrl": "string",
- "icon": "string",
- "id": 0,
- "name": {
- "ext": "string",
- "full": "string",
- "short": "string"
}, - "url": "string"
}
], - "author": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "content": "string",
- "createdAgo": "string",
- "createdAt": "string",
- "createdAtPosix": 0,
- "id": 0,
- "is_best": 0,
- "objectId": 0,
- "ownership": "string",
- "replyToId": 0,
- "updatedAt": "string",
- "votes": {
- "amount": 0,
- "canVote": true,
- "isVoted": true,
- "plural": "string"
}
}, - "canBeCommented": true,
- "category": {
- "description": null,
- "forum": {
- "id": "string",
- "name": "string"
}, - "id": 0,
- "image": {
- "big": "string",
- "medium": "string",
- "small": "string"
}, - "isPrivate": true,
- "name": "string",
- "order": 0,
- "ownership": null,
- "parent_id": 0,
- "slug": "string",
- "type": null
}, - "commentedAt": "string",
- "commentsNum": 0,
- "completedBy": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "completedOn": "string",
- "content": "string",
- "createdAt": "string",
- "createdAtPosix": 0,
- "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "forum": {
- "id": "string",
- "name": "string"
}, - "id": 0,
- "isAbused": true,
- "isFeatured": true,
- "isPrivate": true,
- "isSubscribed": 0,
- "language": "string",
- "latestActivityPosix": 0,
- "links": [
- {
- "object_id": "string",
- "title": "string",
- "type": "string",
- "url": "string"
}
], - "ownership": "string",
- "parentObject": null,
- "recipients": [
- "string"
], - "responsible": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "score": 0,
- "scoreComment": "string",
- "scoreReason": "string",
- "slaDatePosix": 0,
- "slug": "string",
- "source": {
- "identifier": "string",
- "name": "string"
}, - "state": {
- "identifier": 0,
- "name": "string"
}, - "status": {
- "color": {
- "background": "string",
- "text": "string"
}, - "id": 0,
- "isClosed": true,
- "isDefault": true,
- "isSystem": true,
- "order": 0,
- "ownership": "string",
- "slug": "string",
- "title": "string",
- "type": "string"
}, - "tags": [
- "string"
], - "team": {
- "id": 0,
- "name": "string"
}, - "title": "string",
- "type": {
- "icon": {
- "big": "string",
- "small": "string"
}, - "order": 0,
- "slug": "string",
- "supports": {
- "comments": true,
- "negativeVote": true,
- "votes": true
}, - "title": {
- "plural": "string",
- "single": "string"
}
}, - "url": "string",
- "views": 0,
- "votes": {
- "all": 0,
- "canVote": true,
- "isVoted": true,
- "negative": 0,
- "plural": "string",
- "positive": 0
}
}
], - "firstPage": 0,
- "lastPage": 0,
- "nextPage": 0,
- "objectsPerPage": 0,
- "totalObjects": 0,
- "totalPages": 0
}
}
id required | integer Example: 4 The numerical ID of the report |
sort | string Enum: "new" "new_updated" "activity" "completed_on" "comments" "sla_date" "csat" Sorts the result by given filter. |
groupValue | string ID of the report group. Can be taken from groups array in the response. |
page | integer Default: 1 Example: page=5 The number of page |
perPage | integer Default: 50 Example: perPage=150 Count of objects per page |
{- "activeGroup": "string",
- "currentPage": 0,
- "data": [
- {
- "attachments": [
- {
- "directUrl": "string",
- "icon": "string",
- "id": 0,
- "name": {
- "ext": "string",
- "full": "string",
- "short": "string"
}, - "url": "string"
}
], - "author": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "bestComment": {
- "attachments": [
- {
- "directUrl": "string",
- "icon": "string",
- "id": 0,
- "name": {
- "ext": "string",
- "full": "string",
- "short": "string"
}, - "url": "string"
}
], - "author": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "content": "string",
- "createdAgo": "string",
- "createdAt": "string",
- "createdAtPosix": 0,
- "id": 0,
- "is_best": 0,
- "objectId": 0,
- "ownership": "string",
- "replyToId": 0,
- "updatedAt": "string",
- "votes": {
- "amount": 0,
- "canVote": true,
- "isVoted": true,
- "plural": "string"
}
}, - "canBeCommented": true,
- "category": {
- "description": null,
- "forum": {
- "id": "string",
- "name": "string"
}, - "id": 0,
- "image": {
- "big": "string",
- "medium": "string",
- "small": "string"
}, - "isPrivate": true,
- "name": "string",
- "order": 0,
- "ownership": null,
- "parent_id": 0,
- "slug": "string",
- "type": null
}, - "commentedAt": "string",
- "commentsNum": 0,
- "completedBy": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "completedOn": "string",
- "content": "string",
- "createdAt": "string",
- "createdAtPosix": 0,
- "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "forum": {
- "id": "string",
- "name": "string"
}, - "id": 0,
- "isAbused": true,
- "isFeatured": true,
- "isPrivate": true,
- "isSubscribed": 0,
- "language": "string",
- "latestActivityPosix": 0,
- "links": [
- {
- "object_id": "string",
- "title": "string",
- "type": "string",
- "url": "string"
}
], - "ownership": "string",
- "parentObject": null,
- "recipients": [
- "string"
], - "responsible": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "score": 0,
- "scoreComment": "string",
- "scoreReason": "string",
- "slaDatePosix": 0,
- "slug": "string",
- "source": {
- "identifier": "string",
- "name": "string"
}, - "state": {
- "identifier": 0,
- "name": "string"
}, - "status": {
- "color": {
- "background": "string",
- "text": "string"
}, - "id": 0,
- "isClosed": true,
- "isDefault": true,
- "isSystem": true,
- "order": 0,
- "ownership": "string",
- "slug": "string",
- "title": "string",
- "type": "string"
}, - "tags": [
- "string"
], - "team": {
- "id": 0,
- "name": "string"
}, - "title": "string",
- "type": {
- "icon": {
- "big": "string",
- "small": "string"
}, - "order": 0,
- "slug": "string",
- "supports": {
- "comments": true,
- "negativeVote": true,
- "votes": true
}, - "title": {
- "plural": "string",
- "single": "string"
}
}, - "url": "string",
- "views": 0,
- "votes": {
- "all": 0,
- "canVote": true,
- "isVoted": true,
- "negative": 0,
- "plural": "string",
- "positive": 0
}
}
], - "firstPage": 0,
- "groups": [
- {
- "count": 0,
- "id": "string",
- "name": "string"
}
], - "lastPage": 0,
- "nextPage": 0,
- "objectsPerPage": 0,
- "totalObjects": 0,
- "totalPages": 0
}
{- "success": [
- {
- "author": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "content": "string",
- "createdAgo": "string",
- "createdAt": "string",
- "createdAtPosix": 0,
- "id": 0,
- "updatedAt": "string"
}
]
}
content required | string The content of a new comment. Supports BBcode, but HTML tags are not allowed Max content length: 12000 chars |
remind_at | string Not empty string containing user’s name |
{- "content": "My first note",
- "remind_at": "2017-10-13 18:29:00"
}
{- "success": [
- {
- "author": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "content": "string",
- "createdAgo": "string",
- "createdAt": "string",
- "createdAtPosix": 0,
- "id": 0,
- "updatedAt": "string"
}
]
}
content required | string The content of a new comment. Supports BBcode, but HTML tags are not allowed Max content length: 12000 chars |
remind_at | string Not empty string containing user’s name |
{- "content": "My first note",
- "remind_at": "2017-10-13 18:29:00"
}
{- "success": [
- {
- "author": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "content": "string",
- "createdAgo": "string",
- "createdAt": "string",
- "createdAtPosix": 0,
- "id": 0,
- "updatedAt": "string"
}
]
}
content required | string The content of a new comment. Supports BBcode, but HTML tags are not allowed Max content length: 12000 chars |
remind_at | string Not empty string containing user’s name |
{- "content": "My first note",
- "remind_at": "2017-10-13 18:29:00"
}
{- "success": [
- {
- "author": {
- "apiKey": "string",
- "avatar": {
- "big": "string",
- "medium": "string",
- "small": "string",
- "tiny": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "label": "string",
- "name": "string",
- "textValue": [
- null
], - "value": [
- null
]
}
], - "gravatarEmail": null,
- "id": 0,
- "isDefaultAvatar": true,
- "lastVisitAt": "string",
- "name": "string",
- "profileUrl": "string",
- "registrationDate": "string",
- "role": {
- "alias": "string",
- "id": 0
}, - "shortName": "string",
- "team": {
- "id": 0,
- "name": "string"
}
}, - "content": "string",
- "createdAgo": "string",
- "createdAt": "string",
- "createdAtPosix": 0,
- "id": 0,
- "updatedAt": "string"
}
]
}