get
https://gateway.remote.com/v1/employments//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 withsub_type: employer_managed_documentare 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 assub_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 theurn:ietf:params:oauth:grant-type:jwt-bearergrant 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 type | Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|---|
| Company-scoped access token | Manage 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 token | Manage employment documents (employment_documents) | View documents (document:read) | Manage documents (document:write) |
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Callback