List employments
Changed onLists all employments, except for the deleted ones.
This endpoint requires and returns country-specific data. The exact required and returned fields will vary depending on which country the employment is in. To see the list of parameters for each country, see the Show form schema endpoint under the Countries category.
Please note that the compliance requirements for each country are subject to change according to local laws. Given its continual updates, using Remote's json-schema-form should be considered in order to avoid compliance issues and to have the latest version of a country requirements.
If you are using this endpoint to build an integration, make sure you are dynamically collecting or displaying the latest parameters for each country by querying the "Show form schema" endpoint.
For more information on JSON Schemas, see the How JSON Schemas work documentation.
To learn how you can dynamically generate forms to display in your UI, see the documentation for the json-schema-form tool.
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/employments
- 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)
Query parameters
Company ID
Filters the results by employments whose login email matches the value
Filters the results by the employee's name. Each whitespace-separated word is matched partially, ignoring casing and accents, so grace hop matches "Gráce Brewster Murray Hopper".
Filters the results by employments whose status matches the value. Supports multiple values separated by commas. Also supports the value incomplete to get all employments that are not onboarded yet.
Allowed values: active, created, created_awaiting_reserve, created_reserve_paid, initiated, invited, pending, pre_hire, review, job_title_review, pending_post_self_enrollment_actions, archived, incomplete. Any other value returns a 422. Offboarded employments have the status archived.
Filters the results by employments whose employment product type matches the value
Filters the results by employments whose employment model matches the value. Possible values: global_payroll, peo, eor
Filters the results by the employment's short ID. Returns at most one result.
Filters the results by the partner_external_id value the calling integration holds for the employment; another integration's identifiers are never matched. Matching is exact, including case. The same value may be set on several employments (for example a rehire), so several results may be returned.
Starts fetching records after the given page
Number of items per page
Headers
Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow.
The refresh token needs to have been obtained through the Authorization Code flow.
Response
Success
Example response
{
"current_page": 1,
"employments": [
{
"country": {
"alpha_2_code": "PT",
"code": "PRT",
"contractor_products_available": [
"standard",
"plus",
"cor"
],
"country_subdivisions": [
{
"code": "PT-06",
"name": "Coimbra",
"subdivision_type": "District"
},
{
"code": "PT-11",
"name": "Lisboa",
"subdivision_type": "District"
}
],
"employment_agreement_preview_available": true,
"eor_onboarding": true,
"global_payroll_supported": true,
"locked_benefits": "after_first_hire",
"name": "Portugal",
"region": "Europe",
"subregion": "Southern Europe",
"supported_json_schemas": [
"additional_documents",
"address_details",
"administrative_details",
"employment-basic-information",
"bank_account_details",
"contract_details",
"emergency_contact"
]
},
"department": null,
"department_id": null,
"employment_lifecycle_stage": "employment_creation",
"employment_model": "eor",
"external_id": "1234567890",
"full_name": "Jane Smith",
"id": "add736b8-employment-id-a76ccae2abe8",
"job_title": "Engineer",
"login_email": "janesmith@company.com",
"partner_external_id": "EMP-1234",
"personal_email": "janesmith@company.com",
"short_id": "1234567890",
"status": "created",
"type": "employee",
"work_address_details": {},
"work_email": "janesmith@company.com"
}
],
"total_count": 1,
"total_pages": 1
}Changes
- info
added the optional property
////to the response with the status
- info
- info
removed the
offboardingenum value from the///response property for the response status
- info