Skip to main content
GET
Get a trial
  • Credential: an API key of the account that owns the trial. A trial key returns 401 unauthorized.
  • Line-scoped keys: the list of lines of a line-scoped key is not applied.
  • Events: none.
  • Personal data: paired_handle, the prospect’s phone number or the email address of their Apple ID. Request it only when needed, do not copy it into logs, tickets or other tools, and refer to a prospect by an id of your own.
  • Status: status can still read pairing_pending after the pairing window ended, until GET /v1/trial/status is called for the trial: see Statuses.

Errors

The errors that every operation shares are in Errors.

Authorizations

Authorization
string
header
required

An API key created in the iSnap dashboard, or a trial key, sent as Authorization: Bearer <key>. An API key starts with isnap_live_ or isnap_test_; both act on the same account, lines and billing. A trial key acts on its trial only.

Path Parameters

trial_id
string
required

Id of the trial, as returned in trial_id by POST /v1/trial/init: trl_ followed by 25 letters or digits.

Minimum string length: 1
Example:

"trl_4Lp8Rn2xY7wQ9mK3vB5nH8dF2"

Response

The trial.

success
enum<boolean>
required

Always true on a success response.

Available options:
true
data
object
required

A trial, as the account that started it reads it.

trace_id
string
required

Trace id of the request that produced this response: 32 lowercase hexadecimal characters. Quote it when you report a problem to iSnap.

request_id
string
required

Id of the request that produced this response: req_ followed by 25 letters or digits.