Get basic information
Changed onReturns the employment's basic information.
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/v2/employments/{employment_id}/basic-information
- 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
Employment ID
Query parameters
Version of the employment_basic_information form schema
When true, returns tax_servicing_countries grouped into global/regions/subregions instead of a flat list of country names.
Response
Success
Example response
{
"data": {
"employment": {
"contract_origin": "remote_contract",
"id": "20a72f86-employment-id-9e4942a902ff",
"personal_details": {},
"status": "created",
"type": "employee",
"updated_at": "2024-01-15T10:30:00Z",
"user_status": "active"
}
}
}Changes
- warning
added the new
invitedenum value to the//response property for the response status
- warning
- info
removed the
offboardingenum value from the//response property for the response status
- info