API Reference

List document types (Beta)

get
https://api.joinpopp.com/v1/document-types

Beta: this endpoint is still in active development; response shape and filter behaviour may change.

Searches the document types for the caller's organization. Backed by OpenSearch — supports prefix match on name, exact match on externalId, and boolean filters on isArchived and isUsedInCampaign. Results are sorted by createdAt (newest first).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Prefix match on the document type name (case-insensitive).

string

Exact match on the customer-controlled external ID.

string
enum

Filter by archive state. Pass "true" or "false".

Allowed:
string
enum

Filter to types currently referenced by a campaign or workflow. Pass "true" or "false".

Allowed:
integer

Maximum number of items to return.

string

Pagination token returned by a previous list call.

Responses

Updated 5 days ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 days ago