List bulk employment rows
Changed onReturns grouped bulk employment rows, including field-level validation errors in errors, row-level failures in row_errors, and submission-phase failures in submission_errors. If a row passes validation but later fails during Global Payroll activation, that failure is surfaced here after submission rather than in the initial create response.
Authentication
This endpoint accepts any one of the following token types:
- Company-scoped access token (OAuth2AuthorizationCode) — obtained through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
- Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page. See Authorization for customers.
Scopes
| Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|
| Manage employments (employments) | View employments (employment:read) | Manage employments (employment:write) |
Request
- Base URL: https://gateway.remote.com
- URL: https://gateway.remote.com/v1/bulk-employment-jobs/{job_id}/rows
- Auth: HTTP bearer and OAuth 2 (authorization code, authorization URL /auth/oauth2/authorize, token URL /auth/oauth2/token, scopes: https://gateway.remote.com/company.manage, employment:read, employment:write, employments, all:write, all:read)
Path parameters
Bulk employment job id
Query parameters
Starts fetching records after the given page
Number of items per page
Response
Success
Example response
{
"data": {
"counts_by_column": {
"feature_a": {
"error": 3,
"valid": 27
},
"sla_days": {
"error": 2,
"valid": 28
}
},
"counts_by_status": {
"deleted": 0,
"error": 2,
"imported": 8,
"pending": 5,
"retryable": 0,
"skipped": 0,
"successful": 10,
"unprocessable": 0
},
"current_page": 1,
"rows": {
"failures": [
{
"data": {
"foo": "bar",
"number": 1
},
"errors": {
"email": [
"is invalid"
]
},
"metadata": {
"employment_slug": "abc123-slug"
},
"row_error_details": {
"ambiguous": [
{
"amount": 25000,
"created_by": {
"name": "Bertrand Russell",
"slug": "user-b"
},
"effective_date": "2022-01-01",
"employee_identifier": "gp_employee@example.com",
"end_date": null,
"inserted_at": "2026-04-24T10:00:00Z",
"occurrence": "once",
"pay_item": "2060 Shift Allw Morning",
"slug": "epe-1"
}
]
},
"row_errors": {
"ambiguous": [
"Multiple pay items match."
]
},
"row_number": 1,
"submission_errors": []
}
],
"imported": [
{
"data": {
"foo": "bar",
"number": 1
},
"errors": {
"email": [
"is invalid"
]
},
"metadata": {
"employment_slug": "abc123-slug"
},
"row_error_details": {
"ambiguous": [
{
"amount": 25000,
"created_by": {
"name": "Bertrand Russell",
"slug": "user-b"
},
"effective_date": "2022-01-01",
"employee_identifier": "gp_employee@example.com",
"end_date": null,
"inserted_at": "2026-04-24T10:00:00Z",
"occurrence": "once",
"pay_item": "2060 Shift Allw Morning",
"slug": "epe-1"
}
]
},
"row_errors": {
"ambiguous": [
"Multiple pay items match."
]
},
"row_number": 1,
"submission_errors": []
}
],
"pending": [
{
"data": {
"foo": "bar",
"number": 1
},
"errors": {
"email": [
"is invalid"
]
},
"metadata": {
"employment_slug": "abc123-slug"
},
"row_error_details": {
"ambiguous": [
{
"amount": 25000,
"created_by": {
"name": "Bertrand Russell",
"slug": "user-b"
},
"effective_date": "2022-01-01",
"employee_identifier": "gp_employee@example.com",
"end_date": null,
"inserted_at": "2026-04-24T10:00:00Z",
"occurrence": "once",
"pay_item": "2060 Shift Allw Morning",
"slug": "epe-1"
}
]
},
"row_errors": {
"ambiguous": [
"Multiple pay items match."
]
},
"row_number": 1,
"submission_errors": []
}
],
"retryable": [
{
"data": {
"foo": "bar",
"number": 1
},
"errors": {
"email": [
"is invalid"
]
},
"metadata": {
"employment_slug": "abc123-slug"
},
"row_error_details": {
"ambiguous": [
{
"amount": 25000,
"created_by": {
"name": "Bertrand Russell",
"slug": "user-b"
},
"effective_date": "2022-01-01",
"employee_identifier": "gp_employee@example.com",
"end_date": null,
"inserted_at": "2026-04-24T10:00:00Z",
"occurrence": "once",
"pay_item": "2060 Shift Allw Morning",
"slug": "epe-1"
}
]
},
"row_errors": {
"ambiguous": [
"Multiple pay items match."
]
},
"row_number": 1,
"submission_errors": []
}
],
"skipped": [
{
"data": {
"foo": "bar",
"number": 1
},
"errors": {
"email": [
"is invalid"
]
},
"metadata": {
"employment_slug": "abc123-slug"
},
"row_error_details": {
"ambiguous": [
{
"amount": 25000,
"created_by": {
"name": "Bertrand Russell",
"slug": "user-b"
},
"effective_date": "2022-01-01",
"employee_identifier": "gp_employee@example.com",
"end_date": null,
"inserted_at": "2026-04-24T10:00:00Z",
"occurrence": "once",
"pay_item": "2060 Shift Allw Morning",
"slug": "epe-1"
}
]
},
"row_errors": {
"ambiguous": [
"Multiple pay items match."
]
},
"row_number": 1,
"submission_errors": []
}
],
"successes": [
{
"data": {
"foo": "bar",
"number": 1
},
"errors": {
"email": [
"is invalid"
]
},
"metadata": {
"employment_slug": "abc123-slug"
},
"row_error_details": {
"ambiguous": [
{
"amount": 25000,
"created_by": {
"name": "Bertrand Russell",
"slug": "user-b"
},
"effective_date": "2022-01-01",
"employee_identifier": "gp_employee@example.com",
"end_date": null,
"inserted_at": "2026-04-24T10:00:00Z",
"occurrence": "once",
"pay_item": "2060 Shift Allw Morning",
"slug": "epe-1"
}
]
},
"row_errors": {
"ambiguous": [
"Multiple pay items match."
]
},
"row_number": 1,
"submission_errors": []
}
],
"unprocessable": [
{
"data": {
"foo": "bar",
"number": 1
},
"errors": {
"email": [
"is invalid"
]
},
"metadata": {
"employment_slug": "abc123-slug"
},
"row_error_details": {
"ambiguous": [
{
"amount": 25000,
"created_by": {
"name": "Bertrand Russell",
"slug": "user-b"
},
"effective_date": "2022-01-01",
"employee_identifier": "gp_employee@example.com",
"end_date": null,
"inserted_at": "2026-04-24T10:00:00Z",
"occurrence": "once",
"pay_item": "2060 Shift Allw Morning",
"slug": "epe-1"
}
]
},
"row_errors": {
"ambiguous": [
"Multiple pay items match."
]
},
"row_number": 1,
"submission_errors": []
}
]
},
"total_count": 25,
"total_pages": 2
}
}Changes
- info
added the optional property
/to the response with the status
- info
- info
added the optional property
////to the response with the status - info
added the optional property
////to the response with the status - info
added the optional property
////to the response with the status - info
added the optional property
////to the response with the status - info
added the optional property
////to the response with the status - info
added the optional property
////to the response with the status - info
added the optional property
////to the response with the status
- info