REremote-com
Employee Personal Details

Show employee personal details

Returns the authenticated employee's personal details.

This endpoint requires country-specific data. Query the Show form schema endpoint with personal_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 typeCategoryRead only ScopeWrite only Scope (read access implicit)
Employee-scoped access tokenManage employments (employments)View personal details (personal_detail:read)Manage personal details (personal_detail:write)
Company-scoped access tokenManage employments (employments)View personal details (personal_detail:read)-
get/v1/employee/personal-details

Request

  • Base URL
    https://gateway.remote.com
  • URL
    https://gateway.remote.com/v1/employee/personal-details
  • Auth
    • OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token scopes: personal_detail:read
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token scopes: all:read
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token scopes: all:write
    • or OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: personal_detail:read
    • or OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: all:read
    • or OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: all:write

Query parameters

integer

Specific version number

OR
'latest'

Use latest version

Version of the personal_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.