COconnecteam
Documents:v1:Documents

Get user documents

Changed on

Retrieve which documents are assigned to which users, through document packs the caller is authorized to view, together with each user's status on each document. Filter by document id to see who a document is assigned to and where each user stands, or by user id to see one employee's assigned documents and compliance state. At least one filter is required.

get/documents/v1/user-documents

Request

  • Base URL
    https://api.connecteam.com
  • URL
    https://api.connecteam.com/documents/v1/user-documents
  • Auth
    • API key in header X-API-KEY
    • or OAuth 2
      Client credentials
      Token URL: /oauth/v1/token scopes: documents.read

Query parameters

documentIdsinteger[] nullable

Only include these document ids, up to 100

userIdsinteger[] nullable

Only include these user ids, up to 100

status'pendingUserUpload' | 'pendingUserFilling' | 'pendingAdminFilling' | 'pendingYourCompletion' | 'pendingApproval' | 'approved' | 'rejected'

Only include documents with this status

expiringBeforeinteger nullable

Integer with minimum value of 0

Only include documents whose expiration date is set and earlier than this epoch-seconds timestamp. Covers both entry-level and document-level expiration

limitinteger

The maximum number of results to display per page

offsetinteger

The resource offset of the last successfully read resource will be returned as the paging.offset JSON property of a paginated response containing more results

Response

Successful Response

requestIdstring

Changes