Hey there, how can we help?

Popular searches: Sync, Bear Pro, Migrate

X callback url Scheme documentation

Bear implements the x-callback-url protocol, which allow iOS and Mac developers to expose and document API methods they make available to other apps and return useful data.

Bear URL Scheme actions look like this:

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

with x-success and x-error as available x-callback parameters.

Actions


/open-note

Open a note identified by its title or id and return its content.

parameters

x-success

example

bear://x-callback-url/open-note?id=7E4B681B bear://x-callback-url/open-note?id=7E4B681B&header=Secondary%20Ttitle

Create and try /open-note actions in seconds with our URL builder online


/create

Create a new note and return its unique identifier. Empty notes are not allowed. This call can't be performed if the app is a locked state.

parameters

x-success

example

bear://x-callback-url/create?title=My%20Note%20Title&text=First%20line&tags=home,home%2Fgroceries

Create and try /create actions in seconds with our URL builder online

notes

The base64 file parameter have to be encoded when passed as an url parameter.


/add-text

append or prepend text to a note identified by its title or id. Beta encrypted notes can't be accessed with this call.

parameters

x-success

example

bear://x-callback-url/add-text?text=new%20line&id=4EDAF0D1&mode=append

Create and try /add-text actions in seconds with our URL builder online


/add-file

append or prepend a file to a note identified by its title or id. This call can't be performed if the app is a locked state. Encrypted notes can't be accessed with this call.

parameters

x-success

example

bear://x-callback-url/add-file?filename=test.gif&id=4EDAF0D1-2EFF-4190-BC1D-67D9BAE49BA9-28433-000187BAA3D182EF&mode=append&file=R0lGODlhAQABAIAAAP%2F%2F%2F%2F%2F%2F%2FyH5BAEKAAEALAAAAAABAAEAAAICTAEAOw%3D%3D

Create and try /add-file actions in seconds with our URL builder online

notes

The base64 file parameter have to be encoded when passed as an url parameter.


/tags

Return all the tags currently displayed in Bear's sidebar. This call can't be performed if the app is a locked state.

parameters

x-success

example

bear://x-callback-url/tags?token=123456-123456-123456

Create and try /tags actions in seconds with our URL builder online


/open-tag

Show all the notes which have a selected tag in bear. This call can't be performed if the app is a locked state.

parameters

x-success

Encypted notes will be excluded from the notes array.

If token is not provided nothing is returned.

example

bear://x-callback-url/open-tag?name=work bear://x-callback-url/open-tag?name=todo%2Fwork

Create and try /open-tag actions in seconds with our URL builder online


/rename-tag

Rename an existing tag. This call can't be performed if the app is a locked state. If the tag contains any locked note this call will not be performed.

parameters

example

bear://x-callback-url/rename-tag?name=todo&new_name=done

Create and try /rename-tag actions in seconds with our URL builder online


/delete-tag

Delete an existing tag. This call can't be performed if the app is a locked state. If the tag contains any locked note this call will not be performed.

parameters

example

bear://x-callback-url/delete-tag?name=todo

Create and try /delete-tag actions in seconds with our URL builder online


/trash

Move a note to bear trash and select the Trash sidebar item. This call can't be performed if the app is a locked state. Encrypted notes can't be used with this call.

parameters

example

bear://x-callback-url/trash?id=7E4B681B bear://x-callback-url/trash?search=old

Create and try /trash actions in seconds with our URL builder online

notes

The search term is ignored if an id is provided.


/archive

Move a note to bear archive and select the Archive sidebar item. This call can't be performed if the app is a locked state. Encrypted notes can't be accessed with this call.

parameters

example

bear://x-callback-url/archive?id=7E4B681B bear://x-callback-url/archive?search=projects

Create and try /archive actions in seconds with our URL builder online

notes

The search term is ignored if an id is provided.


/untagged

Select the Untagged sidebar item. This call can't be performed if the app is a locked state.

parameters

x-success

Encypted notes will be excluded from the notes array.

If token is not provided nothing is returned.

example

bear://x-callback-url/untagged?search=home

Create and try /untagged actions in seconds with our URL builder online


/todo

Select the Todo sidebar item. This call can't be performed if the app is a locked state.

parameters

x-success

Encypted notes will be excluded from the note array.

If token is not provided nothing is returned.

example

bear://x-callback-url/todo?search=home

Create and try /todo actions in seconds with our URL builder online


/today

Select the Today sidebar item. This call can't be performed if the app is a locked state.

parameters

x-success

Encypted notes will be excluded from the note array.

If token is not provided nothing is returned.

example

bear://x-callback-url/today?search=family

Create and try /today actions in seconds with our URL builder online


/locked

Select the Locked sidebar item. This call can't be performed if the app is a locked state.

parameters

example

bear://x-callback-url/locked?search=data

Create and try /locked actions in seconds with our URL builder online


Show search results in Bear for all notes or for a specific tag. This call can't be performed if the app is a locked state.

parameters

x-success

Encypted notes will be excluded from the note array.

If token is not provided nothing is returned.

example

bear://x-callback-url/search?term=nemo&tag=movies

Create and try /search actions in seconds with our URL builder online


/grab-url

Create a new note with the content of a web page. This call can't be performed if the app is a locked state.

parameters

x-success

available values

yes no

example

bear://x-callback-url/grab-url?url=https://bear.app

Create and try /grab-url actions in seconds with our URL builder online


/change-theme

Change the selected Bear theme. Some themes may require a Bear Pro subscription.

parameters

available values

Red Graphite Charcoal Solarized Light Solarized Dark Panic Mode Dracula Gotham Toothpaste Cobalt Duotone Light Duotone Snow Dieci Ayu Ayu Mirage Dark Graphite Duotone Heat Gandalf

example

bear://x-callback-url/change-theme?theme=Solarized%20Dark

Create and try /change-theme actions in seconds with our URL builder online


/change-font

Change the selected Bear Font.

parameters

available values

Avenir Next System Helvetica Neue Menlo Georgia Courier Open Dyslexic

example

bear://x-callback-url/change-font?font=Helvetica%20Neue

Create and try /change-font actions in seconds with our URL builder online


Token Generation

In order to extend their functionalties, some of the API calls allow an app generated token to be passed along with the other parameters. Please mind a Token generated on iOS is not valid for MacOS and vice-versa.

On MacOS, select HelpAPI TokenCopy Token and will be available in your pasteboard.

On iOS go to the preferences → General, locate the API Token section and tap the cell below to generate the token or copy it in your pasteboard.

Support

To discuss URL scheme improvements or reporting bugs please use our Support Form or Bear's subreddit.

Contact Us