Organization Widget
API for Organization Widget object
API | GET | POST | PUT | PATCH | DELETE |
Organization Widget List | Admin, Member | Admin | - | - | - |
Organization Widget Detail | Admin, Member | - | - | Admin * | Admin |
*Can only change is_archivedfield.
getOrganization Widget List
get
{{ base_url }} /organizations/organizationwidget/list/{level}/{sid}/{serializer}/
Request
Response
Request
Path Parameters
level
required
string
organization
sid
required
string
organization sid
serializer
required
string
​
Headers
token
required
string
​
Response
200: OK
# serializer = name{"page_size": 10,"page_number": 1,"page_count": 9,"count": 81,"next": "xxx","previous": null,"add_permission": true,"results": [{"sid": "ehkn0a40x1glqvAFKP","name": "Plain Text"},...]}​# serializer = list{"page_size": 10,"page_number": 1,"page_count": 9,"count": 81,"next": "xxx","previous": null,"add_permission": true,"results": [{"sid": "xxx","is_archived": false,"change_permission": true},...]}​# serializer = detail{"page_size": 10,"page_number": 1,"page_count": 9,"count": 81,"next": "xxx","previous": null,"add_permission": true,"results": [{"sid": "xx","is_archived": false,"updated_by": "xxx","date_updated": "2020-02-10T03:02:28.525127Z","date_created": "2020-02-10T03:02:28.523525Z","change_permission": true},...]}
postOrganization Widget List
post
{{ base_url }} /organizations/organizationwidget/list/{level}/{sid}/{serializer}/
Request
Response
Request
Path Parameters
level
required
string
organization
sid
required
string
organization sid
serializer
required
string
​
Headers
token
required
string
​
Form Data Parameters
widget
required
object
​
Response
201: Created
{"sid": "xx","is_archived": false,"updated_by": "xxx","date_updated": "2020-02-10T03:02:28.525127Z","date_created": "2020-02-10T03:02:28.523525Z","change_permission": true}
406: Not Acceptable
- Error: Invaid widget sid!- Error: the widget is not available for your organization!
getOrganization Widget Detail
get
{{ base_url }} /organizations/organizationwidget/detail/{sid}/
Request
Response
Request
Path Parameters
sid
required
string
​
Headers
token
required
string
​
Response
200: OK
{"sid": "xx","is_archived": false,"updated_by": "xxx","date_updated": "2020-02-10T03:02:28.525127Z","date_created": "2020-02-10T03:02:28.523525Z","change_permission": true}
deleteOrganization Widget Detail
delete
{{ base_url }} /organizations/organizationwidget/detail/{sid}/
Request
Response
Request
Path Parameters
sid
required
string
​
Headers
token
required
string
​
Response
204: No Content
{}
Last updated 5 months ago