Contracts
Employment Contracts

List contract documents for an employment

Changed on

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 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 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: HTTP bearer and OAuth 2 (authorization code, authorization URL /auth/oauth2/authorize, token URL /auth/oauth2/token, scopes: https://gateway.remote.com/company.manage, document:read, document:write, employment_documents, all:write, all:read)

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

  • c9d3f8b8186aRevision changes
    • warning

      added the new deadline_passed enum value to the /// response property for the response status

    • info

      added the enum value deadline_passed to the property items/ of the query request parameter except_statuses

    • info

      added the enum value deadline_passed to the property items/ of the query request parameter statuses