v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14126767600.8 KB

Searches for workers.

post/2023-10-12/farms/{farmId}/search/workers

Path parameters

farmIdstring required

The farm ID in the workers search.

Request body

itemOffsetinteger required

The offset for the search results.

pageSizeinteger

Specifies the number of results to return.

fleetIdsFleetId[] required

The fleet ID of the workers to search for.

Response

Success

nextItemOffsetinteger

The next item offset for the search results.

totalResultsinteger required

The total number of results in the search.