Retrieve Workers
GET
workers
Retrieves a paginated list of all Workers, optionally filtered and sorted. When additional results are available, the pagination object in the response payload provides a “nextUrl” that links to the next page of results.
Resource Information
| Method and URI | GET https://api.aps.autodesk.com/fusion-operations/v2/workers |
| Authentication Context | No security required |
| Required OAuth Scopes | data:read data:write |
| Data Format | JSON |
Request
Headers
| Authorization* string | JWT Access Token |
* Required
Request
Query String Parameters
| filter[id] int | Filter Workers matching the specified id. |
| filter[name] string | Filter Workers by name, providing the Worker name. Pass the value as URL‑encoded. |
| filter[number] int | Filter Workers by number, providing the Worker number |
| filter[section.id] int | Filter Workers by section, providing the id. |
| filter[section.name] string | Filter Workers by section, providing the name. Pass the value as URL‑encoded. |
| filter[disabled] boolean | Filter Workers by status. If true, returns only disabled Workers; if false or omitted, returns only enabled Workers. |
| limit int | Maximum number of results returned. Defaults to 25. |
| offset int | Page offset. Default value is 0. |
| sort string | Comma separated fields to sort items by. Fields: id, number. Default: “number asc”. |
Response
HTTP Status Code Summary
| 200 OK | A list of Workers. |
| 400 Bad Request | Bad request due to invalid data. |
| 401 Unauthorized | The access token is invalid. It may have either expired or may not be a three-legged access token. Please verify the token and retry the request. |
| 403 Forbidden | The request was successfully validated but lacked required permission. Please verify your token permissions and retry the request. |
| 429 Too Many Requests | Rate limit exceeded; wait some time before retrying. |
| 500 Internal Server Error | An unknown server-side error occurred. Please try again later. If the problem persists, please contact support. |
Response
Header (429)
| Retry-After integer | The number of seconds to wait before retrying the request. |
Response
Body Structure (200)
Expand all
| results array: object | List of Workers |
| id int | Unique identifier of the worker. |
| number int | The number assigned to the worker |
| name string | Max length: 255 |
| disabled boolean | |
| shift | The current active shift for the worker |
| id int | Unique identifier of the referenced entity. |
| code string | Code of the referenced entity.
Max length: 255 |
| anyOf | The current active shift for the worker |
| 0 | |
| 1 | |
| customCode string | NFC/RFId/SmartCard/Barcode for login
Max length: 255 |
| costPerHour number | The value assigned to each hour of labor |
| language enum:string | Possible values: PT, EN, DE, ES, PL, ZH, FR, IT, JP, KR, TR, PT_BR, BG |
| sections array: object | |
| id int | Unique identifier of the referenced entity. |
| name string | Name of the referenced entity.
Max length: 255 |
| anyOf | |
| 0 | |
| 1 | |
| pagination object | |
| limit int | Maximum number of results returned in this page. |
| offset int | Number of results skipped before this page. |
| nextUrl string | URL for the next page of results. Null when there are no additional pages. |
Example
A list of Workers.
Request
curl -v 'https://developer.api.autodesk.com/fusion-operations/v2/workers' \
-H 'Authorization: '
Response
{
"results": [
{
"id": 382,
"number": 66,
"name": "Peter Johnson",
"disabled": false,
"shift": {
"id": 3,
"code": "Morning"
},
"customCode": "9876qwer",
"costPerHour": 25.5,
"language": "EN",
"section": {
"id": 2,
"name": "Assembly Section"
}
},
{
"id": 385,
"number": 68,
"name": "Andrew Smith",
"disabled": false,
"shift": {
"id": 3,
"code": "Morning"
},
"customCode": "1234qwer",
"costPerHour": 25.5,
"language": "FR",
"sections": [
{
"id": 2,
"code": "Assembly",
"name": "Assembly Section"
},
{
"id": 4,
"code": "Packaging",
"name": "Packaging Section"
}
]
}
],
"pagination": {
"limit": 20,
"offset": 0,
"nextUrl": null
}
}
Show More