_linkedin_partner_id = "503794"; window._linkedin_data_partner_ids = window._linkedin_data_partner_ids || []; window._linkedin_data_partner_ids.push(_linkedin_partner_id);

List Templates API V2

List Templates API V2 Introduction

This API is used to retrieve all templates meta information (limited info) that exists within an institution’s account. The API request includes pagination options for card templates. A ‘limit’ and ‘offset’ can be passed along with the api-key to get a set of data. These fields are optional, if not passed in the request then the first 10 templates of the account will get returned in the response.

Request Format

POST /api/v2/ HTTP/1.1
Host: secure.id123.io
X-API-KEY: API_KEY
Content-Type: application/json
Content-Length: 52

{
   "action": "list-templates",
   "limit": 0, //(optional),
   "offset": 10, //(optional)   
}

Success Response

{
   "status": "success",
   "code": "SUCCESS CODE",
   "message": "Card Templates were retrieved successfully.",
   "data": [
       {
           "card-template-id": "CARD_TEMPLATE_ID",
           "institution": "INSTITUTE NAME",
           "issuance-type": "INSTITUTION_ISSUED",
           "title": "TEMPLATE_TITLE",
           "created-at": "yyyy-mm-ddThh:mm:ss+00:00 (UTC)",
           "last-updated": "yyyy-mm-ddThh:mm:ss+00:00 (UTC)"
       }
   ]
}

Failure Response

{
	"status": "failure",
        "code": "ERROR CODE",
        "message": "ERROR MESSAGE"
}

.

.

.

Go to Top