Keep It URL Support

Contents


Links to Lists and Items

Both Keep It for Mac and Keep It for iPad and iPhone can link to items and lists:

Linking to Items

Keep It can copy a link to a specific item that can be pasted anywhere.

On Mac:

While listing items on iPad or iPhone:

While viewing an item on iPad or iPhone:

The link will be in the following format:

keepit://link?item=[identifier]

Linking to Lists

Keep It can copy a link to a specific list that can be pasted anywhere.

On Mac:

On iPad or iPhone:

The link will be in the following format:

keepit://link?list=[identifier]

X-Callback-URLs

Keep It for iPad and iPhone (v1.4.2 and later) and Keep It for Mac (v1.8 and later) support the x-callback-url format.

Use the keepit:// scheme, ensure URLs are in the standard x-callback-url format and that all parameters are URL encoded.

keepit://x-callback-url/[action]?[parameters]&[x-callback parameters]

The examples shown omit x-callback parameters for brevity, and assume the default new file type is note, and not stationery.

Identifying Lists and Items

All lists and items in Keep It have unique identifiers, which can be incorporated into links (see above). It is possible to obtain these identifiers without copying a full link.

Copying Identifiers on iPad or iPhone

Lists:

Items:

Copying Identifiers on Mac

Although x-callback-urls are only used on iOS, it is possible to get a link identifier for both lists and items on Mac.

Lists:

Items:

Available Actions

add

Add a note, text file, other file from data, or a web link.

Input Parameters:
Return Values:
Notes
Examples:

Create a web link called “Apple Homepage” with the URL http://apple.com:

keepit://x-callback-url/add?name=Apple%20Homepage&source=http%3A%2F%2Fapple.com

Create a web link called “Apple” with the URL http://apple.com, and the tags “tag 1” and “tag 2”:

keepit://x-callback-url/add?name=Apple&source=http%3A%2F%2Fapple.com&tags=tag%201,tag%202

Create a note with the text “The quick brown fox jumps over the lazy dog”:

keepit://x-callback-url/add?text=The%20quick%20brown%20fox%20jumps%20over%20the%20lazy%20dog

Create a plain text file with the text “The quick brown fox jumps over the lazy dog” (Keep It 1.5 and later):

keepit://x-callback-url/add?text=The%20quick%20brown%20fox%20jumps%20over%20the%20lazy%20dog&format=txt

Create a note with the text “The quick brown fox” in the All Items group:

keepit://x-callback-url/add?text=The%20quick%20brown%20fox&group=AllItems

Create a PNG image from the data (truncated in example):

keepit://x-callback-url/add?format=png&data=iVBORw0KGgoAAAANSUhEUgAAAgA…

Create an image with the name “Keep It.png” from the data (truncated in example):

keepit://x-callback-url/add?name=Keep%20It.png&data=iVBORw0KGgoAAAANSUhEUgAAAgA…

append

Append text to a note, rich text, Markdown or plain text file. Append a file attachment to a note or rich text file.

Input Parameters:
Return Values:
Notes
Examples:

Append “The quick brown fox” to an item with identifier C96F26E6-A566-457E-A448-5B0F527714DE:

keepit://x-callback-url/append?text=The%20quick%20brown%20fox&item=C96F26E6-A566-457E-A448-5B0F527714DE

Append an image (data truncated in example) with the name “App Icon.png” to an item with identifier 079B3A6A-18B4-41A6-858B-3F3DBA6F87F3:

keepit://x-callback-url/append?name=App%20Icon.png&item=079B3A6A-18B4-41A6-858B-3F3DBA6F87F3&data=iVBORw0KGgoAAAANSUhEUgAAAHgAAAB4CAYAAAA5ZDb…