Retrieve Document Set

​

Retrieve a document set and its current lifecycle state. Poll this endpoint to track progress and update your product's progress UI.

Path Parameters
  • id
    Type: string
    required

    Document set identifier.

Responses
  • application/vnd.api+json
Request Example for get/v1/document_sets/{id}
curl https://api.clerky.com/v1/document_sets/12 \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "data": {
    "type": "document_sets",
    "id": "12",
    "links": {
      "app": "https://app.clerky.com/document_sets/12"
    },
    "attributes": {
      "state": "input_needed",
      "template": "startup_delaware-corporation"
    }
  }
}

The document set.