Skip to main content
GET
/
api
/
company
/
workers
List company workers
curl --request GET \
  --url https://api.sandbox.bitwage.com/api/company/workers \
  --header 'Authorization: Basic <encoded-value>'
{
  "data": [
    {
      "user_id": "<string>",
      "email": "jsmith@example.com",
      "first_name": "<string>",
      "last_name": "<string>",
      "onboarding_complete": true,
      "has_distributions": true
    }
  ],
  "meta": {
    "page": 123,
    "total": 123,
    "pages": 123,
    "has_prev": true,
    "has_next": true,
    "prev_num": 123,
    "next_num": 123,
    "per_page": 123
  }
}

Authorizations

Authorization
string
header
required

API key authentication. Include your access token as: Authorization: Basic <ACCESS_TOKEN>

Query Parameters

company_id
string
required
user_id
string

Filter by worker user ID.

email
string

Filter by worker email.

page
integer

Page number.

Required range: x >= 1
per_page
integer

Number of items per page.

Required range: x >= 1

Response

200 - application/json

Paginated worker list.

data
object[]
meta
object