About

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

Getting started with the REST API is easy, and can be done from command line and 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 "john@example.com:00001234cafecafe" "https://api.testfairy.com/api/1/projects/"

In the example above, you can see that our user is john@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 https://app.testfairy.com/settings.


api/1/projects

Get all projects GET /api/1/projects/

api/1/projects/{project-id}/builds/

Get all builds in a project GET /api/1/projects/{project-id}/builds/

api/1/projects/{project-id}/builds/{build-id}/crashes/

List all crashes in build GET /api/1/projects/{project-id}/builds/{build-id}/crashes/

api/1/projects/{project-id}/builds/{build-id}/sessions/

List all recorded sessions in build GET /api/1/projects/{project-id}/builds/{build-id}/sessions/

api/1/projects/{project-id}/builds/{build-id}/sessions/{session-id}/

Get session data, events and logs GET /api/1/projects/{project-id}/builds/{build-id}/sessions/{session-id}/

api/1/testers/

List all testers GET /api/1/testers/
Add a new tester POST /api/1/testers/