list labels
/groups/{group}/labels [GET]
| API Support | Available since | Last updated | Output |
|---|---|---|---|
| 4.6212 | 5.9700 | json, xml |
Description
Returns the list of labels in a group.
Parameters
| Name | Description | Required | Type | Default value |
|---|---|---|---|---|
| types | Comma-separated list of label types to return | no | string |
The label type can be any combination of:
- comment
- fragment
- edit-note
- version
- creation
- upload
- document
- xref
- content-inline
- content-block
Permission
This service requires guest unless the group is accessible to public.
Response
The output has the following format:
<label-config scope="[server|project|document]"
template="[project]"
updated="[updated date time]">
<labels type="[comment|
fragment|
edit-note|
version|
creation|
upload|
document|
xref|
content-inline|
content-block]">
<label name="[label name]" description="[label description]"/>
<label name="[label name]" description="[label description]"/>
...
</labels>
...
</label-config>
Error Handling
No specific errors expected for this service.