Contractors
Eligibility

Get eligibility questionnaire schema

Returns the JSON schema for the eligibility questionnaire by type.

The schema defines the structure and validation rules for the questionnaire responses. Supports versioning to allow for schema evolution while maintaining backwards compatibility.

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/contractors/schemas/eligibility-questionnaire

Request

  • Base URL: https://gateway.remote.com
  • URL: https://gateway.remote.com/v1/contractors/schemas/eligibility-questionnaire
  • 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)

Query parameters

type'contractor_of_record' required
Example:contractor_of_record

Type of eligibility questionnaire

integer

Specific version number

OR
'latest'

Use latest version

Version of the form schema

Response

Success

Example response

{
  "data": {
    "permissions": {},
    "schema": {
      "properties": {
        "question_key1": {
          "type": "string"
        },
        "question_key2": {
          "type": "string"
        }
      },
      "required": [
        "question_key1",
        "question_key2"
      ],
      "type": "object"
    },
    "version": 1
  }
}

Changes

No recorded changes to this operation across all 65 revisions of this API.