Skip to navigation
API ReferenceTemplates

ListSuggestedTemplates

ListSuggestedTemplates returns the field selection to start an export from, one per entity and target the filter admits: the defaults, with the team’s CRM field mappings for a CRM target and the order, visibility and (for a file) column names of its latest template.

Authentication

AuthorizationBearer

A team API key, sent as Authorization: Bearer <key>.

OR
AuthorizationBearer

The Cognito access token of a signed-in Edulead user (edulead auth login), sent as Authorization: Bearer <token>.

Headers

Edulead-TeamstringRequired

Query parameters

filter.entityenumOptional

Only suggestions for this entity; UNSPECIFIED means every entity. enum.defined_only = true

Allowed values:
filter.targetenumOptional

Only suggestions for this target; UNSPECIFIED means every target. enum.defined_only = true

Allowed values:
page_sizeintegerOptional0-100
Number of items per page, at most the maximum shown. Omitted or 0 means the RPC's default page size.
page_tokenstringOptional<=512 characters

Opaque token from a previous response; empty for the first page.

order_byenumOptional

Sort order: a sortable field name, optionally followed by ” desc”. The allowed values are listed.

Allowed values:

Response

Success
itemslist of objectsOptional
The page of results, in the requested order.
next_page_tokenstringOptional

Token for the next page; empty when this is the last page.