Skip to content

List published templates

GET
/templates
curl --request GET \
--url https://necodoc.example.com/api/v1/templates \
--header 'x-api-key: <x-api-key>'

Published, non-archived templates, limited to the key’s templates if it has any.

lang
string
/^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})*$/

Return name and description in this language from the template’s translations; untranslated text stays as written.

Templates by name.

Media typeapplication/json
Array<object>
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
kind
required
string
Allowed values: designed overlay
name
required
string
>= 1 characters <= 200 characters
description
required
string
<= 2000 characters
latestVersion
required
Any of:
integer
>= -9007199254740991 <= 9007199254740991
publishedAt
required
Any of:
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$/
createdAt
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$/
updatedAt
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$/
languages
required

The published version’s document language first, then those it has translations for. Pass one as output.lang, or as ?lang= here.

Array<string>

Example

[
{
"kind": "designed"
}
]

Missing, unknown, revoked or expired key, or the key’s account is disabled.

Media typeapplication/json
object
error
required
string
code
required
string
fieldErrors
object
key
additional properties
Array<string>
generationId
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Example generated

{
"error": "example",
"code": "example",
"fieldErrors": {
"additionalProperty": [
"example"
]
},
"generationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

The key lacks the scope, role, template or source address this call needs.

Media typeapplication/json
object
error
required
string
code
required
string
fieldErrors
object
key
additional properties
Array<string>
generationId
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Example generated

{
"error": "example",
"code": "example",
"fieldErrors": {
"additionalProperty": [
"example"
]
},
"generationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Invalid request or data; fieldErrors lists each.

Media typeapplication/json
object
error
required
string
code
required
string
fieldErrors
object
key
additional properties
Array<string>
generationId
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Example generated

{
"error": "example",
"code": "example",
"fieldErrors": {
"additionalProperty": [
"example"
]
},
"generationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Rate limit exceeded.

Media typeapplication/json
object
error
required
string
code
required
string
fieldErrors
object
key
additional properties
Array<string>
generationId
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Example generated

{
"error": "example",
"code": "example",
"fieldErrors": {
"additionalProperty": [
"example"
]
},
"generationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}
Retry-After
integer

Seconds until the key may call again.