Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Remote Employee Personal Details API

The Employee Personal Details API from Remote — 1 operation(s) for employee personal details.

Remote Employee Personal Details API is one of 101 APIs that Remote publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Employee Personal Details. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 2 operations across 1 path, and defines 12 schemas. It is described by OpenAPI 3.0.0, at version 0.1.0.

Requests are made against 2 base URLs: https://gateway.remote.com/, https://gateway.remote-sandbox.com/.

2 operations 1 paths 12 schemas 1 GET1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
0.1.0
Base URL
https://gateway.remote.com/v1/
Authentication
HTTP Basic, HTTP Bearer, HTTP Bearer, OAuth 2.0, OAuth 2.0, OAuth 2.0, OAuth 2.0
Resource Areas
1

Authentication & Security 7

Remote Employee Personal Details API declares 7 security schemes for authenticating requests. It accepts HTTP basic authentication (BasicAuth). It accepts HTTP bearer tokens (ClientToken). It accepts HTTP bearer tokens (CustomerAPIToken). It supports OAuth 2.0 (OAuth2) using the authorizationCode and clientCredentials flows, exposing 77 scopes. It supports OAuth 2.0 (OAuth2Assertion) using the clientCredentials flow, exposing 21 scopes. It supports OAuth 2.0 (OAuth2AuthorizationCode) using the authorizationCode flow, exposing 73 scopes. It supports OAuth 2.0 (OAuth2ClientCredentials) using the clientCredentials flow, exposing 18 scopes. By default, every request must be authenticated.

  • BasicAuth — Authenticate using the basic authentication for partners. Use the CLIENTID as login and CLIENTSECRET as password.
  • ClientToken — Authenticate a partner using only the the provided clienttoken. This authentication method only allows accessing marketing endpoints.
  • CustomerAPIToken — Authenticate using API Key generated by the customer in their Integration Settings page.
  • OAuth2 — Authenticate using OAuth 2.0 protocol.
  • OAuth2Assertion — Authenticate as the employee using the urn:ietf:params:oauth:grant-type:jwt-bearer grant in the OAuth2 protocol.
  • OAuth2AuthorizationCode — Authenticate as the token authorizer using authorizationcode / refreshtoken grants in the OAuth 2.0 protocol.
  • OAuth2ClientCredentials — Authenticate using clientcredentials grant in the OAuth 2.0 protocol.

Paths & Operations 2

Across 1 path, the API surfaces 2 operations — 1 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Employee Personal Details 2
GET
/v1/employee/personal-details
Show employee personal details
get_v1_employee_personal-details 1 param → 200400401403404429
PUT
/v1/employee/personal-details
Update employee personal details
put_v1_employee_personal-details 1 param body → 200400401403404422429

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are ActionError (3 properties), ParameterError (3 properties), TooManyRequestsResponse (1 property), EmploymentPersonalDetailsParams (1 property). Each schema is shown below with its type and property counts.

EmploymentDetailsOnlyResponse
object
Response containing only the updated details struct plus base employment fields (id, status, type, updatedat, userstatus). Exactly one of the details propertie…
1 property 1 required
ParameterError
object
3 properties 3 required
UserStatus
string
The status of the user account associated with this employment. - active: The user account is active and the user can log in. - created: The user account has b…
UnauthorizedResponse
object
Returned when the request does not include valid authentication credentials. Ensure you are passing a valid OAuth2 access token or API token in the Authorizati…
1 property 1 required
ForbiddenResponse
object
Returned when the authenticated user or token does not have permission to perform the requested action. Check that the token has the required OAuth2 scopes and…
1 property 1 required
UnprocessableEntityResponse
object
NotFoundResponse
object
Returned when the requested resource does not exist or is not accessible with the current authentication credentials.
1 property
EmploymentStatus
string
The current status of the employment record. - active: The employee is fully onboarded and actively working. - created: The employment has been created but onb…
BadRequestResponse
object
Returned when the request is malformed or contains invalid parameters. The message may be a simple string or a structured object with a code and detailed messa…
EmploymentPersonalDetailsParams
object
Employment personal details.
1 property 1 required
TooManyRequestsResponse
object
Returned when the API rate limit has been exceeded (HTTP 429). Wait before retrying. Check the Retry-After response header for the recommended wait time.
1 property
ActionError
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

remote-employee-personal-details-api-openapi.yml Raw ↑

Other APIs Remote publishes across the network.

Remote Address Details API
Remote Administrative Details API
Remote Background Checks API
Remote Bank Account Details API
Remote Basic Information API
Remote Benefit Offers API
Remote Benefit Offers By Employment API
Remote Benefit Renewals API
Remote Benefits API
Remote Billing Address Details API
Remote Billing API
Remote Billing Documents API