Employments
Engagement Agreement Details

Get engagement agreement details

Changed on

Returns the engagement agreement details for an employment.

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

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage employments (employments)View employments (employment:read)Manage employments (employment:write)
get/v1/employments/{employment_id}/engagement-agreement-details

Request

  • Base URL: https://gateway.remote.com
  • URL: https://gateway.remote.com/v1/employments/{employment_id}/engagement-agreement-details
  • 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_idstring required

Employment ID

Response

Success

Example response

{
  "data": {
    "details": {
      "has_business_presence": "no",
      "has_similar_roles": "no"
    },
    "slug": "93t3j-engagement-agreement-details-id"
  }
}

Changes

  • e0218441d35cRevision changes
    • breaking

      the /// response's property type changed from integer to number, and format from no format to double for status

  • 470aaa69d54fRevision changes
    • breaking

      added subschema #1: EngagementAgreementDetailsDEU to the / response property oneOf list for the response status

    • info

      removed subschema #1: EngagementAgreementDetailsParamsDEU from the / response property oneOf list for the response status