Get Supporting Document Templates
GET https://{{host}}/v3/supporting_document_templates
Lists all supporting document templates.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
filter[permanent] | null | boolean - Filters by the permanent field. |
- Allow blank - No.
- Allow array - No. |
|
filter[name]
| null | |string
- Filters by the name field. - Allow blank - No.
- Allow array - No. |
|
filter[name_contains]
| null | |string
- Filters by the name_contains field. - Allow blank - No.
- Allow array - No. |
|
fields[supporting_document_templates]
| null | | The value of thefields
parameter MUST be a comma-separated (U+002C COMMA, “,”) list that refers to the name(s) of the fields to be returned.
An empty value indicates that no fields should be returned.
Allowed values:
name - The name
field.
permanent - The permanent
field.
url - The url
field.
|
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string | ||
Content-Type | string | ||
Api-Key | string |
RESPONSES
status: OK
{"data":[{"id":"a6f8fa4f-302b-447a-880f-f68407c67e78","type":"supporting_document_templates","attributes":{"name":"Germany Registration Form","permanent":true,"url":"https://api.didww.com/storage/public/kb5ovqxc43xhompzcrhh6e3fz7mo"}}],"meta":{"total_records":1,"api_version":"2022-05-10"},"links":{"first":"https://api.didww.com/v3/supporting_document_templates?filter%5Bname_contains%5D=Germany\u0026page%5Bnumber%5D=1\u0026page%5Bsize%5D=50","last":"https://api.didww.com/v3/supporting_document_templates?filter%5Bname_contains%5D=Germany\u0026page%5Bnumber%5D=1\u0026page%5Bsize%5D=50"}}