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",
  "status": "active",
  "tags": [
    "<string>"
  ],
  "createdBy": "<string>",
  "owners": [
    "[email protected]"
  ],
  "createdAt": "<string>",
  "updatedAt": "<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"

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:
active,
paused
tags
string[]
required
createdBy
string | null
required

Email of who recorded the source session

owners
string[]
required

Owner email addresses

Example:
createdAt
string
required
updatedAt
string
required