REremote-com
Employment Contracts

List contract documents for an employment

Only contractor employment types are supported. Lists contract documents for a specific employment with pagination, filtering by status, and sorted by updated_at descending (latest first).

Authentication

This endpoint accepts any one of the following token types:

  • Company-scoped access token (OAuth2AuthorizationCode) — obtained by a company manager through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
  • Company-scoped access token (assertion) (OAuth2CompanyManagerAssertion) — obtained through the urn:ietf:params:oauth:grant-type:jwt-bearer grant for a company manager. See OAuth Assertion.
  • Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page, with the scopes they choose there. See Authorization for customers.

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)
Company-scoped access tokenManage employment documents (employment_documents)View documents (document:read)Manage documents (document:write)
Company-scoped access token (assertion)Manage employment documents (employment_documents)View documents (document:read)Manage documents (document:write)
Customer API tokenManage employment documents (employment_documents)View documents (document:read)Manage documents (document:write)
get/v1/employments/{employment_id}/contract-documents

Request

  • Base URL
    https://gateway.remote.com
  • URL
    https://gateway.remote.com/v1/employments/{employment_id}/contract-documents
  • Auth
    • OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: https://gateway.remote.com/company.manage
    • or OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: document: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
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token scopes: document: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 HTTP bearer

Path parameters

employment_idstring required

Employment ID

Query parameters

statusesContractorContractDocumentStatus[]

Filter by contract document statuses

[
  "draft"
]
except_statusesContractorContractDocumentStatus[]

Exclude contract documents with specific statuses

[
  "draft"
]
pageinteger

Starts fetching records after the given page

page_sizeinteger

Number of items per page

Response

Success

Example response

{
  "data": {
    "contract_documents": [
      {
        "id": "0073fcb5-b669-4e4a-b963-2a47744e75a1",
        "inserted_at": "2024-01-15T10:30:00Z",
        "name": "Contract Agreement.pdf",
        "signatories": [
          {
            "email": "john@example.com",
            "name": "John Doe",
            "signed_at": "2024-01-15T10:30:00Z",
            "status": "signed",
            "type": "employee",
            "user_id": "0073fcb5-b669-4e4a-b963-2a47744e75a1"
          }
        ],
        "status": "finished",
        "type": "contractor_services_agreement",
        "updated_at": "2024-01-16T14:20:00Z"
      }
    ],
    "current_page": 1,
    "total_count": 1,
    "total_pages": 1
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.