Objects

Articles

Article Object
Field Overview Name Type Example Notes project_id String 559f118932131c6576ccb5be *Required unique identifier status String published *...
Article Version Object
Field Overview Name Type Example Notes project_id String 559f118932131c6576ccb5be *Required. ID of the knowledge base this belongs to. status String active *Required. Can be one of the following: 'active', 'delete...
Category Object
Field Overview Name Type Example Notes project_id String 559f118932131c6576ccb5be *Required unique identifier status String active *Required. Can be one of the following: 'active',  'deleted'. url_hash U...
Comment Object
Field Overview Name Type Example Notes project_id String 559f118932131c6576ccb5be *Required unique identifier status String active *Req...
File Object
Field Overview Name Type Example Notes project_id String 559f118932131c6576ccb5be *Required unique identifier name String File Name *Re...
Reader Object
Field Overview Name Type Example Notes username String john@johndoe.com *Required. If you are using the setting "Allow readers to administer their own passwords&quo...
Reader Group Object
Field Overview Name Type Example Notes name String Reader Group Name *Required. status String active *Required. Can be one of the follo...
Tag Object
Field Overview Name Type Example Notes project_id String 559f118932131c6576ccb5be *Required unique identifier name String Tag Name *Req...