Workers
List workers
LiveServed by the v1 API in development with the same checks as production; production opens on the same contract. The capabilities from before v1 keep running in production at the path your account team gives you.
GET
Workers of your company, newest first, in pages of up to 500. Filter by your own id, by status or by RFC.
oauth2 workers:readheader
AuthorizationBearer <token>OAuth 2.0 client credentials. Exchange your client_id and client_secret at /oauth/token of the environment for a bearer token valid for one hour. The playground of every operation asks for your own client and keeps it in your browser tab only.
Scope: workers:read
external_id?stringFilter by your id.
status?stringFilter by status.
Value in
"ready""pending""in_progress""blocked""not_evaluated""removed"rfc?stringFilter by RFC.
cursor?stringFrom next_cursor of the previous page.
limit?integer1 to 500.
Default
100OK
application/json- response
data*array<>next_cursor*|nullcurl -X GET 'https://api.dev.b2b.heru.app/v1/workers'{ "data": [ { "id": "string", "external_id": "string", "status": "ready", "curp": "string", "rfc": "string", "name": "string", "postal_code": "string", "regimes": [ { "code": "string", "description": "string" } ], "services": [ "fiscal_validation" ], "efirma": { "active": true, "valid_from": "2019-08-24", "valid_to": "2019-08-24" }, "csd": { "active": true, "valid_from": "2019-08-24", "valid_to": "2019-08-24" }, "open_actions": [ "give_consent" ], "enrollment": { "status": "pending", "url": "http://example.com", "expires_at": "2019-08-24T14:15:22Z", "completed_at": "2019-08-24T14:15:22Z" }, "consent_at": "2019-08-24T14:15:22Z", "compliant_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "removed_at": "2019-08-24T14:15:22Z" } ], "next_cursor": "string"}