Employee Emergency Contact
Show employee emergency contact
Returns the authenticated employee's emergency contact.
The employment is derived from the access token's subject — there is no employment id in the path.
This endpoint requires country-specific data. The exact required fields vary depending on which country the authenticated employee's employment is in. Query the Show form schema endpoint with emergency_contact_details as the form name to discover the schema for a given country.
Authentication
This endpoint accepts any one of the following token types:
- Employee-scoped access token (OAuth2Assertion) — obtained through the urn:ietf:params:oauth:grant-type:jwt-bearer grant. See OAuth Assertion.
- Company-scoped access token (OAuth2AuthorizationCode) — obtained by the employee through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
Scopes
Any one of the scopes in a token type's row is enough. all:read and all:write work too.
| Token type | Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|---|
| Employee-scoped access token | Manage employments (employments) | View emergency contacts (emergency_contact:read) | Manage emergency contacts (emergency_contact:write) |
| Company-scoped access token | Manage employments (employments) | - | - |
get/v1/employee/emergency-contact
Request
- Base URLhttps://gateway.remote.com
- URLhttps://gateway.remote.com/v1/employee/emergency-contact
- Auth
- OAuth 2Client credentialsToken URL: /auth/oauth2/token scopes: emergency_contact:read
- or OAuth 2Client credentialsToken URL: /auth/oauth2/token scopes: all:read
- or OAuth 2Client credentialsToken URL: /auth/oauth2/token scopes: all:write
- or OAuth 2Authorization code: /auth/oauth2/authorizeToken URL: /auth/oauth2/token scopes: employments
- or OAuth 2Authorization code: /auth/oauth2/authorizeToken URL: /auth/oauth2/token scopes: all:read
- or OAuth 2Authorization code: /auth/oauth2/authorizeToken URL: /auth/oauth2/token scopes: all:write
Query parameters
Version of the emergency_contact_details form schema
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
No recorded changes to this operation across all 1 revision of this API.