This is the reference document for the TestFairy REST API. This API allows the developer to access and interact with TestFairy data remotely.
Getting started with the REST API is easy, and can be done via command line with any programming language. Let's begin with a simple example. We will start by listing all our projects.
A project is either an iOS app or an Android app (two apps with the same package name but on different platforms are considered two projects.)
curl -u "firstname.lastname@example.org:00001234cafecafe" "https://api.testfairy.com/api/1/projects/"
In the example above, you can see that our user is
email@example.com and the API key is
0001234cafecafe. This user authentication token is required for all requests to the REST server.
Your API key is private, please do not share it or post it on public code repositories or forums. To find your API key, please refer to your preferences page.
Last updated on 2020-05-07