List Document Collection templates

Vorschau
gethttps://api.expiryedge.com/v2/collection-templates
any member of an organization60/min
Anfrage
curl 'https://api.expiryedge.com/v2/collection-templates?status=active&limit=50' \
  -H "Authorization: Bearer $EXPIRYEDGE_API_KEY"
Antwort
{
  "data": [
    {
      "id": "tem_123",
      "organization_id": "org_123",
      "name": "Example name",
      "description": "string",
      "status": "active",
      "pages": [
        {
          "id": "tem_123",
          "title": "string",
          "order": 1,
          "description_html": "string",
          "sections": []
        }
      ],
      "intro_email": {},
      "schema_version": 1,
      "created_by": "string",
      "created_by_name": "Example name"
    }
  ],
  "next_cursor": "string",
  "has_more": true
}

Ordered by id, cursor-paginated.

Query-Parameter

  • statusstring
    Erlaubtactivearchivedrequest_draftrequest_sentallStandard active
  • sortstring
    Erlaubtid
  • cursorstring
    Opaque next_cursor from the previous page. Only valid with the same sort.
  • limitinteger
    Page size, 1-100 (values above 100 are clamped; default 50).
    Standard 50min: 1 · max: 100

Rückgabe

200
A page of templates.
  • dataarray of objectserforderlich
  • next_cursorstring | nullerforderlich
  • has_morebooleanerforderlich

Fehler

400
Invalid parameters or body (VALIDATION_FAILED; details names the fields).
401
Missing, invalid or expired token (UNAUTHORIZED).
403
Your role can't do this, or your account has no organization (FORBIDDEN).
405
Wrong HTTP method for this path; the Allow header lists the valid ones.
429
Too many requests for this endpoint from your IP. Wait Retry-After seconds.