List employment files

Lists files associated with a specific employment.

Supports filtering by file type and sub_type.

These are the most common types. Other types and sub types exist, and each file in the response shows its type and sub_type.

  • contract: signed contracts. For contractors, this includes contractor services agreements (CSAs), statements of work (SOWs), and custom contractor agreements created from a template. A contractor's contract only appears once everyone has signed it.
  • document: other documents. Files with sub_type: employer_managed_document are documents the company created in Remote from one of its templates and had signed.
  • tax_document: tax forms, such as W-9s (sub_type: w_9_form).
  • id: identity documents, such as sub_type: personal_id.

For contractors, some documents exist both as a file and as a contract document, with different IDs. The API doesn't link them. To avoid storing the same document twice, read Working with Files.

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)
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Employment ID

Query Params
string

Filter by file type (optional). Common values: contract, document, tax_document, id.

string

Filter by file sub_type (optional). For example personal_id, w_9_form or employer_managed_document.

integer
≥ 1
Defaults to 1

Starts fetching records after the given page

integer
1 to 100
Defaults to 20

Number of items per page

Responses

Callback
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json