Skip to main content

Renamed fields and paths

Typograph names everything on the wire by one convention: a stated boolean starts with is_, has_ or can_, a timestamp ends in _at, a count is <noun>_count, a reference into the template document ends in _uuid, and names are written in full. Moving to it renamed the names below in one release, without a transition: the API sends and accepts only the new name, so an integration that reads or sends an old one must switch.

Two places still read the old name, as a deprecated alias, because stored data and customers' packages carry it:

  • Publisher requests: spreads_as_single_pages (now single_pages) and merge.file_name (now merge.filename). When both are sent, the new name wins.
  • Template JSON and template packages: every old key, and a package's templatebundle.json (now template_bundle.json). The template keys are listed under Older key names.

Paths​

OldNew
/v1/file/{resourceType}/{resourceId}/invites[/{id}]/v1/file/{resourceType}/{resourceId}/invitations[/{id}]
/v1/file/users/me/invites/v1/file/users/me/invitations
/v1/file/templates/{id}/collab-token/v1/file/templates/{id}/collaboration-token
/v1/file/recent/searched/v1/file/recent/searches

File service​

OldNewWhere
resolved, ?resolved=is_resolved, ?is_resolved=comment, resolve a comment
expiredis_expiredevery presigned URL
featured, ?featured=is_featured, ?is_featured=pre-made templates
usableis_usablepre-made templates
existsis_foundfont lookup
savedis_savedtouch a template
completeis_completeform values
from, paramssender, parametersnotification
targets[].uuidtargets[].element_uuidtemplate fields
element_idelement_uuidform fields
label_namelabelupdate a font
dev_urldevelopment_urltemplate
thumbnailthumbnail_filenameshared item
total_templates, total_userstemplate_count, user_countproject, team, shared item
?trash=?include_deleted=search
propertyPathproperty_patha 422's violations (also the converter and the publisher)

Identity service and the API home​

OldNewWhere
expiredis_expiredorganization invitation
deletion_scheduled_fordeletion_scheduled_atorganization
my_can_use_quota, my_rolecan_use_quota, roleorganization
websitewebsite_urlorganization, create and update
auth, portal, websiteauthentication, portal_url, website_urlGET /

Publisher, subscription and webhooks​

OldNewWhere
valid, plan.proofis_valid, plan.is_proofmerge check
rows_total, rows_uncheckedrow_count, unchecked_row_countmerge check
rows_total, rows_done, rows_failedrow_count, printed_row_count, failed_row_countmerge job and its publication.* events
current_period_start, current_period_endcurrent_period_starts_at, current_period_ends_atsubscription
period_start, period_endperiod_starts_at, period_ends_atusage
attemptsattempt_countwebhook delivery

MCP server​

OldNew
tools invite_create, invite_list_my, invite_list_resource, invite_accept, invite_decline, invite_deleteinvitation_create, invitation_list_my, invitation_list_resource, invitation_accept, invitation_decline, invitation_delete
argument invite_idinvitation_id
arguments featured, website, font_update.nameis_featured, website_url, label
results deleted, restored, touched, accepted, declined, revoked, removed, marked_read, marked_unread, marked_all_read, code_sentgone: success says it
results download_available, valid, proofis_download_available, is_valid, is_proof
results deletion_scheduled_for, website, earliest_expirydeletion_scheduled_at, website_url, earliest_expires_at

Every other result follows the API's names, booleans included (is_active, is_featured, is_expired).

Webshop API​

OldNew
default (language)is_default
works_in_the_back_officeis_staff
enabled (feedback)is_enabled
personalizableis_personalizable
chosen (facet value)is_selected
downloadable (print file)is_downloadable
print_specprint_specification
?q=?query=
favourites, /users/me/favourites/{slug}, too_many_favouritesfavorites, /users/me/favorites/{slug}, too_many_favorites
order files' element_idelement_uuid