This API is used to query the list of all labeling team members.
GET /v2/{project_id}/workforces/workers
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details about how to obtain the project ID, see Obtaining a Project ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
limit |
No |
Integer |
Maximum number of records returned on each page. The value ranges from 1 to 100. The default value is 10. |
offset |
No |
Integer |
Start page of the paging list. The default value is 0. |
order |
No |
String |
Sorting sequence of the query. The options are as follows: - asc: ascending order - desc: descending order (default value) |
role |
No |
Integer |
Filtering query based on the member role. The options are as follows: - 0: labeling personnel (default value) - 1: reviewer - 2: team administrator |
sort_by |
No |
String |
Sorting mode of the query. The options are as follows: - create_time: Sort by creation time. (Default value) - email: Sort by email. |
None
Status code: 200
Parameter |
Type |
Description |
---|---|---|
total_number |
Integer |
Total number of labeling team members. |
workers |
Array of Worker objects |
Labeling team members list queried by page. |
Parameter |
Type |
Description |
---|---|---|
create_time |
Long |
Creation time. |
description |
String |
Labeling team member description. The value contains 0 to 256 characters and does not support the following special characters: ^!<>=&"' |
String |
Email address of a labeling team member. |
|
role |
Integer |
Role. The options are as follows: - 0: labeling personnel - 1: reviewer - 2: team administrator - 3: dataset owner |
status |
Integer |
Current login status of a labeling team member. The options are as follows: - 0: The invitation email has not been sent. - 1: The invitation email has been sent but the user has not logged in. - 2: The user has logged in. - 3: The labeling team member has been deleted. |
update_time |
Long |
Update time. |
worker_id |
String |
ID of a labeling team member. |
workforce_id |
String |
ID of a labeling team. |
Querying All Labeling Team Administrators
GET https://{endpoint}/v2/{project_id}/workforces/workers??role=2
Status code: 200
OK
{ "total_number" : 2, "workers" : [ { "email" : "xxx@xxx.com", "worker_id" : "df40e4afcb793d13f01f6c9022341e6f", "workforce_id" : "feSUo5NUIUnQAQNNTiS", "status" : 0, "role" : 2, "description" : "", "create_time" : 1595927749772, "update_time" : 1595927749772 }, { "email" : "xxx@xxx.com", "worker_id" : "27906df1d06c0827b7c24f761d618541", "workforce_id" : "XiL5RcHmxyIt3aYIOtI", "status" : 0, "role" : 2, "description" : "", "create_time" : 1590027298717, "update_time" : 1590027298717 } ] }
Status Code |
Description |
---|---|
200 |
OK |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
See Error Codes.