Kits

Get all Kits

curl -XGET 'https://123:wEJAz9dTsRG-CaE9W0r2vKOpKKZY-l48D6TOAXzDiJE@api.lingoapp.com/1/kits/'
// Response
{
  "result": {
    "success": true
    "kit": [{
      "kit_uuid": "3BD9CDAF-14DF-495A-AA2F-4993092D62EE",
      "space_id": 5,
      "name": "Brand Kit",
      "status": "active",
      "use_version": 0,
      "date_added": "2017-03-22 05:27:20.152243+0000",
      "date_updated": "2018-04-12 01:19:33.946433+0000",
      "images": {
        "cover": "https://lingo-test.s3.amazonaws.com:443/kits/5/3BD9CDAF-14DF-495A-AA2F-4993092D62EE/cover_1523495973.png"
      }
    },
    { ... }]
  },
  "server_clock": 1548434315
}

GET /1/kits/

Returns a list of all kits in the space

Kit Versions

curl -XGET 'https://123:wEJAz9dTsRG-CaE9W0r2vKOpKKZY-l48D6TOAXzDiJEapi.lingoapp.com/1/kits/3BD9CDAF-14DF-495A-AA2F-4993092D62EE?include=use_versions'
// Response
{
  "result": {
    "success": true
    "kit": {
      "kit_uuid": "3BD9CDAF-14DF-495A-AA2F-4993092D62EE",
      "space_id": 5235,
      "name": "Brand Kit",
      "status": "active",
      "use_version": 0,
      "date_added": "2017-03-22 05:27:20.152243+0000",
      "date_updated": "2018-04-12 01:19:33.946433+0000",
      "versions": [
        {
          "kit_uuid": "3BD9CDAF-14DF-495A-AA2F-4993092D62EE",
          "status": "active",
          "version": 0,
          "version_identifier": "0.0",
          "notes": "",
          "date_added": "2017-03-22 05:27:20.152243+0000",
          "date_updated": "2017-03-22 05:27:20.152243+0000",
          "counts": {
            "assets": 928,
            "items": 952,
            "sections": 8
          }
        }]
    }
  },
  "server_clock": 1548434315
}

GET /1/kits/<kit_id>?include=<options>

Returns a single kit and its versions

Parameters  
idstring - required The uuid of the kit to fetch
includestring Optionally include the versions of the kit. Valid options include versions, use_versions, empty.

Include options

  • versions: return all versions
  • use_versions: The draft and, if different, the recommended version
  • empty string: return only the kit, no versions

Kit Outline

curl -XGET 'https://123:wEJAz9dTsRG-CaE9W0r2vKOpKKZY-l48D6TOAXzDiJEapi.lingoapp.com/1/kits/3BD9CDAF-14DF-495A-AA2F-4993092D62EE/outline?v=0'
// Response
{
  "result": {
    "success": true
    "kit_version": {
      "kit_uuid": "3BD9CDAF-14DF-495A-AA2F-4993092D62EE",
      "status": "active",
      "version": 0,
      "version_identifier": "0.0",
      "notes": "",
      "date_added": "2017-03-22 05:27:20.152243+0000",
      "date_updated": "2017-03-22 05:27:20.152243+0000",
      "counts": {
        "assets": 125,
        "items": 247,
        "sections": 2
      }
      "sections": [{
          "name": "Brand",
          "uuid": "B1F7A3DD-4E6E-4799-8673-4F857ECC388E",
          "version": 0
          "display_order": 0,
          "headers": [
            {
              "uuid": "D86B229B-0171-4EA3-893D-456760D3E8EF",
              "display_order": -13,
              "name": "Logo",
              "version": 0
            },
            {
              "display_order": 6,
              "name": "Colors",
              "uuid": "B3F207C6-92E4-49AB-9416-44267ADD606E",
              "version": 0
            }
          ]
        },
        {
          "name": "Product",
          "uuid": "237CD43A-B42E-41DC-B00B-E4E88FF7F258",
          "version": 0
          "display_order": 1,
          "headers": [
            {
              "display_order": 22,
              "name": "Images",
              "uuid": "C5EAA76A-C5D7-4986-A4E7-0E4E415FC290",
              "version": 0
            }
          ]
        },
        ]
    }
  },
  "server_clock": 1548434315
}

GET /1/kits/<kit_uuid>/outline/

Retrieve the outline of a kit consisting of a list of sections and the headers within each section.

Parameters  
idstring - required The uuid of the kit to fetch
versioninteger The version of the kit to fetch.
See something wrong or incomplete? Improve this page.
Last update: 2019-05-22 11:59:46 -0700