REremote-com
Employee Documents

Indexes all the documents for the employee

Authentication

This endpoint accepts any one of the following token types:

  • Employee-scoped access token (OAuth2Assertion) — obtained through the urn:ietf:params:oauth:grant-type:jwt-bearer grant. See OAuth Assertion.
  • Company-scoped access token (OAuth2AuthorizationCode) — obtained by the employee through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.

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)
Employee-scoped access tokenManage employment documents (employment_documents)View documents (document:read)Manage documents (document:write)
Company-scoped access tokenManage employment documents (employment_documents)View documents (document:read)Manage documents (document:write)
get/v1/employee/documents

Request

  • Base URL
    https://gateway.remote.com
  • URL
    https://gateway.remote.com/v1/employee/documents
  • Auth
    • 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 OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: https://gateway.remote.com/employment.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

Query parameters

pageinteger

Starts fetching records after the given page

page_sizeinteger

Number of items per page

namestring

Filter documents by their description or file name, accepts full and partial case insensitive matches

inserted_afterstring date

UTC date in ISO 8601 format

Example:2021-07-01

Filters the results that were uploaded on or after a given date

inserted_beforestring date

UTC date in ISO 8601 format

Example:2021-07-01

Filters the results that were uploaded before a given date

sort_by'description' | 'document_source' | 'inserted_at' | 'name' | 'type' | 'uploaded_by_role' | 'related_to' | 'sub_type' | 'uploaded_by'

Field to sort by

order'asc' | 'desc'

Sort order

Response

Success

Example response

{
  "current_page": 1,
  "documents": [
    {
      "id": "9880b711-file-id-ecf8f551bd78",
      "inserted_at": "2021-07-15T18:18:17Z",
      "name": "id.pdf",
      "sub_type": "personal_id",
      "type": "id"
    }
  ],
  "total_count": 1,
  "total_pages": 1
}

Changes

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