Collect API
1.0

Welcome to Collect Developer documentation.

The Collect REST API is a collection of HTTPS endpoints to enable any application that supports HTTPS requests to send and receive data from a Collect account.

This is the documentation for version 1.0 of the API. Last update on Apr 23, 2024.

Base URL 
https://api.usecollect.com/v1

Trigger docs sync

POST /syncdocs

This endpoint allows you to trigger the synchronisation of uploaded documents to a cloud storage. Only the documents that have not been synced so far will be sent to the cloud.

application/json

Body

  • requestId string Required

    The ID of the request you want to trigger the synchronisation.

Responses

POST /syncdocs 
curl \
 -X POST https://api.usecollect.com/v1/syncdocs \
 --user "username:password" \
 -H "Content-Type: application/json" \
 -d '{"requestId":"nw42MmBsJoccgutST"}'
Request example 
{
  "requestId": "nw42MmBsJoccgutST"
}
Response examples (200) 
{
  "request": {
    "_id": "nw42MmBsJoccgutST",
    "campaignId": "xvr69EYLKXvTkfYuk",
    "createdAt": "2022-07-04 07:20:06 UTC",
    "portalUrl": "https://app.usecollect.com/portal/uGFRDeEL3Ct2uYo2c/nw42MmBsJoccgutST",
    "status": "pending",
    "dueDate": "2022-07-11 21:59:00 UTC",
    "privacy": "private",
    "contact": {
      "_id": "xtPWKQqcAk8MJfoz5",
      "email": "maincontact@example.com",
      "firstName": "John",
      "lastName": "Doe",
      "nbRequest": 5,
      "createdAt": "2022-07-03 13:51:27 UTC",
      "lastActivity": "2022-07-04 07:20:06 UTC"
    },
    "contributors": [
      {
        "_id": "WmTjsFknzHdmfs3Ra",
        "email": "johndoe@example.com",
        "firstName": "Elon",
        "lastName": "Musk",
        "createdAt": "2022-07-03 13:51:27 UTC"
      }
    ],
    "branding": {
      "useBranding": false
    }
  },
  "errors": []
}