Skip to main content
GET
/
api
/
v1
/
tests
/
{testId}
Get a test
curl --request GET \
  --url https://api.getdecipher.com/api/v1/tests/{testId} \
  --header 'Authorization: Bearer <token>'
{
  "object": "test",
  "id": 123,
  "name": "<string>",
  "url": "https://app.getdecipher.com/tests/456",
  "tags": [
    "<string>"
  ],
  "createdBy": "<string>",
  "owners": [
    "alice@example.com"
  ],
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "steps": [
    {
      "stepNumber": 1,
      "type": "goto",
      "description": "Navigate to login page",
      "data": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

API key authentication. Use your Decipher API key as the bearer token.

Path Parameters

​
testId
string
required

The ID of the test

Example:

"456"

Query Parameters

​
include
enum<string>

Pass "steps" to include the test step definitions in the response

Available options:
steps

Response

Test details

​
object
enum<string>
required
Available options:
test
​
id
number
required
​
name
string
required
​
url
string
required

Decipher dashboard link for the test

Example:

"https://app.getdecipher.com/tests/456"

​
status
enum<string>
required
Available options:
live,
paused
​
tags
string[]
required
​
createdBy
string | null
required

Email of who recorded the source session

​
owners
string[]
required

Owner email addresses

Example:
["alice@example.com"]
​
createdAt
string
required
​
updatedAt
string
required
​
steps
object[]

Test steps. Only present when ?include=steps is set.