> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.getedulead.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.getedulead.com/_mcp/server.

# ListSuggestedTemplates

GET https://api.getedulead.com/v4/templates/suggested

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.

Reference: https://docs.getedulead.com/api-reference/templates/list-suggested-templates

## Authentication

- `Authorization` header (bearer token, required) — A team API key, sent as `Authorization: Bearer <key>`.
- `Authorization` header (bearer token, required) — The Cognito access token of a signed-in Edulead user (`edulead auth login`), sent as `Authorization: Bearer <token>`.

## Request

### Query parameters

- `filter.entity` (enum, optional) — Only suggestions for this entity; UNSPECIFIED means every entity. enum.defined_only = true
  - Allowed values: `EXPORT_ENTITY_UNSPECIFIED`, `EXPORT_ENTITY_CONTACT`, `EXPORT_ENTITY_INSTITUTION`, `EXPORT_ENTITY_INGESTION`
- `filter.target` (enum, optional) — Only suggestions for this target; UNSPECIFIED means every target. enum.defined_only = true
  - Allowed values: `EXPORT_TARGET_UNSPECIFIED`, `EXPORT_TARGET_CSV`, `EXPORT_TARGET_JSON`, `EXPORT_TARGET_HUBSPOT`, `EXPORT_TARGET_SALESFORCE`
- `page_size` (integer, optional) — Number of items per page, at most the maximum shown. Omitted or 0 means the RPC's default page size.
- `page_token` (string, optional) — Opaque token from a previous response; empty for the first page.
- `order_by` (enum, optional) — Sort order: a sortable field name, optionally followed by " desc". The allowed values are listed.
  - Allowed values: ``

## Response

### 200

Success

- `items` (list of edulead.v4.SuggestedTemplate, optional) — The page of results, in the requested order.
- `next_page_token` (string, optional) — Token for the next page; empty when this is the last page.

## Types

### edulead.v4.SuggestedTemplate

SuggestedTemplate is the field selection to start an export of an entity to a target from.

- `entity` (enum, optional) — enum.defined_only = true
  - Allowed values: `EXPORT_ENTITY_UNSPECIFIED`, `EXPORT_ENTITY_CONTACT`, `EXPORT_ENTITY_INSTITUTION`, `EXPORT_ENTITY_INGESTION`
- `target` (enum, optional) — enum.defined_only = true
  - Allowed values: `EXPORT_TARGET_UNSPECIFIED`, `EXPORT_TARGET_CSV`, `EXPORT_TARGET_JSON`, `EXPORT_TARGET_HUBSPOT`, `EXPORT_TARGET_SALESFORCE`
- `mappings` (list of edulead.v4.TemplateMapping, optional) — The fields, in suggested order.

### edulead.v4.TemplateMapping

TemplateMapping is one field of a template: where it goes, its position and whether it is exported, with the field's metadata.

- `source` (string, optional) — The export field, such as email or districtNCESID.
- `target` (string, optional, nullable) — The column name or CRM property it goes to; unset when not mapped.
- `order` (integer, optional) — Its position.
- `visible` (boolean, optional) — Whether it is exported.
- `label` (string, optional) — The field's name; the source when the field is unknown.
- `datatype` (enum, optional) — enum.defined_only = true
  - Allowed values: `TEMPLATE_FIELD_TYPE_UNSPECIFIED`, `TEMPLATE_FIELD_TYPE_STRING`, `TEMPLATE_FIELD_TYPE_NUMBER`, `TEMPLATE_FIELD_TYPE_BOOLEAN`, `TEMPLATE_FIELD_TYPE_DATE`
- `example` (string, optional) — A sample value.
- `required` (boolean, optional) — The target requires the field: it cannot be left out.

## Examples

**Response**

```json
{
  "items": [
    {
      "entity": "EXPORT_ENTITY_UNSPECIFIED",
      "target": "EXPORT_TARGET_UNSPECIFIED",
      "mappings": [
        {
          "source": "string",
          "target": "string",
          "order": 1,
          "visible": true,
          "label": "string",
          "datatype": "TEMPLATE_FIELD_TYPE_UNSPECIFIED",
          "example": "string",
          "required": true
        }
      ]
    }
  ],
  "next_page_token": "string"
}
```

**SDK Code**

```python
import requests

url = "https://api.getedulead.com/v4/templates/suggested"

headers = {"Authorization": "Bearer <apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.getedulead.com/v4/templates/suggested';
const options = {method: 'GET', headers: {Authorization: 'Bearer <apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getedulead.com/v4/templates/suggested"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.getedulead.com/v4/templates/suggested")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.getedulead.com/v4/templates/suggested")
  .header("Authorization", "Bearer <apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.getedulead.com/v4/templates/suggested', [
  'headers' => [
    'Authorization' => 'Bearer <apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.getedulead.com/v4/templates/suggested");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.getedulead.com/v4/templates/suggested")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```