> ## Documentation Index > Fetch the complete documentation index at: https://docs.isnap.ai/llms.txt > Use this file to discover all available pages before exploring further. # Get a trial > Returns one trial that your account owns, with its metadata. * **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](/authentication#line-scoped-keys) 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](/guides/trials#statuses). ## Errors | Status | `error.code` | When | | - | - | - | | 404 | `trial_not_found` | The id is unknown, or the trial belongs to another account. | The errors that every operation shares are in [Errors](/errors-and-rate-limits#errors). ## OpenAPI ````yaml GET /v1/trial/{trial_id} openapi: 3.0.0 info: title: iSnap API version: 2.45.0 description: >- The iSnap API sends and receives iMessage, RCS and SMS on real phone lines, manages those lines, and reports events through webhooks. Every message is sent to a real recipient, with an `isnap_live_` key and with an `isnap_test_` key alike. Retry a `429` after `Retry-After` seconds. Retry a `500` or a `503` up to 2 times, with exponential backoff. Do not retry any other `4xx`: fix the request. Retry a write only on an operation that honors `Idempotency-Key`, with the key of the first attempt. Responses carry personal data: handles, names and message text. servers: - url: https://api.isnap.ai security: - bearerAuth: [] paths: /v1/trial/{trial_id}: get: summary: Get a trial description: >- Returns one trial of the account, with its metadata. Accepts an API key. A line-scoped key is not limited to its list on this operation. `status` stays `pairing_pending` after the pairing window ended, until the trial is read with `GET /v1/trial/status`, which revokes it. A trial of another account, or an unknown id, returns `404 trial_not_found`. No operation lists trials: keep the `trial_id` returned by `POST /v1/trial/init`. `paired_handle` is the handle of the prospect: this is personal data. parameters: - schema: type: string minLength: 1 example: trl_4Lp8Rn2xY7wQ9mK3vB5nH8dF2 description: >- Id of the trial, as returned in `trial_id` by `POST /v1/trial/init`: `trl_` followed by 25 letters or digits. required: true description: >- Id of the trial, as returned in `trial_id` by `POST /v1/trial/init`: `trl_` followed by 25 letters or digits. name: trial_id in: path responses: '200': description: The trial. content: application/json: schema: $ref: '#/components/schemas/TrialEnvelope' '400': description: >- Invalid request. `error.code` is `validation_failed` when a parameter, a header or the body does not match its schema: `error.issues` then lists each problem. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '401': description: No valid credential. `error.code` is `unauthorized`. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '404': description: >- Not found. `error.code` is `trial_not_found`: the account has no trial with this id. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '429': description: >- Too many requests. `error.code` is `rate_limit_exceeded` when more than 100 requests came from the same network address in 60 seconds, whatever their API key or account: wait `error.retry_after` seconds. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '500': description: >- Unexpected failure. `error.code` is `internal_error`. An operation that takes a JSON body also returns it when the body, sent as `application/json`, is not valid JSON. Quote `trace_id` when you report it to iSnap. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' security: - bearerAuth: [] components: schemas: TrialEnvelope: type: object properties: success: type: boolean enum: - true description: Always `true` on a success response. data: $ref: '#/components/schemas/Trial' trace_id: type: string description: >- Trace id of the request that produced this response: 32 lowercase hexadecimal characters. Quote it when you report a problem to iSnap. request_id: type: string description: >- Id of the request that produced this response: `req_` followed by 25 letters or digits. required: - success - data - trace_id - request_id ErrorEnvelope: type: object properties: success: type: boolean enum: - false description: Always `false` on an error response. data: nullable: true description: Always `null` on an error response. error: type: object properties: status: type: integer description: The HTTP status of the response. code: type: string description: >- Stable machine-readable code that names the refusal. Branch on this value. message: type: string description: >- Text for a person. It can change between versions: do not branch on it. retry_after: type: integer nullable: true description: >- Seconds to wait before the next attempt. Set on the `429` responses that know a delay, where the `Retry-After` header carries the same value. When it is above 60 seconds, do not wait in a request: schedule the call, or report the time. `null` on every other error. retry_at: type: string nullable: true description: >- ISO 8601 timestamp at which the refusal ends. Set only on `429 rebind_cap_reached`. `null` on every other error. issues: type: array nullable: true items: type: object properties: path: type: array items: anyOf: - type: string - type: number description: >- Where the problem is: the field names and array indexes that lead to it. message: type: string description: Text for a person. code: type: string description: >- Kind of problem. On `validation_failed`, for example `invalid_type`, `invalid_value`, `invalid_format`, `invalid_union`, `invalid_key`, `invalid_element`, `too_small`, `too_big`, `not_multiple_of`, `unrecognized_keys` or `custom`. The list is open: read `path` and `message`. min: type: integer description: >- Smallest accepted value. Present only on `limit_out_of_bounds`, `mac_quantity_not_a_pack`, `byop_reduction_strands_mac_sessions` and `byop_reduction_strands_byod_lines`. max: type: integer description: >- Largest accepted value. Present only on `limit_out_of_bounds` and `mac_sessions_exceed_byop_lines`, and on the `too_big` issue of an `Idempotency-Key` header longer than 255 characters. required: - path - message - code description: >- Problems found in the request, one entry each. Set on most `400 validation_failed` responses and on the refusals that name a field: a refused `handle` of `POST /v1/lookup` has `issues: null`. `null` on every other error. required: - status - code - message - retry_after - retry_at - issues description: >- What went wrong. The six fields are always present; `retry_after`, `retry_at` and `issues` are `null` when they do not apply. trace_id: type: string description: >- Trace id of the request that produced this response: 32 lowercase hexadecimal characters. Quote it when you report a problem to iSnap. request_id: type: string description: >- Id of the request that produced this response: `req_` followed by 25 letters or digits. required: - success - data - error - trace_id - request_id description: The body of an error response. Trial: type: object properties: trial_id: type: string description: 'Id of the trial: `trl_` followed by 25 letters or digits.' status: type: string enum: - pairing_pending - active - dormant - revoked description: >- `pairing_pending`: waiting for the prospect to send the pairing code. `active`: paired, the trial key can send. `dormant`: paired, sends are refused until the prospect replies, adds a reaction or reads a message; when the trial runs on an iMessage line, a read does not count. `revoked`: ended, and final. pool_line_id: type: string nullable: true description: Id of the line the trial runs on (`line_`). Never `null`. pool_line_number: type: string nullable: true description: Phone number of the line the trial runs on. paired_handle: type: string nullable: true description: >- Handle of the prospect, as the line's device reports it: a phone number or an email address. `null` until the trial is paired. Personal data. metadata: type: object nullable: true additionalProperties: nullable: true description: >- Your metadata on the trial, set with `POST /v1/trial/init` or `PATCH /v1/trial/{trial_id}`, and sent as `data.metadata` on every `trial.*` event. `null` when the trial has none. example: crm_contact_id: c_123 created_at: type: string description: Timestamp of creation, ISO 8601 in UTC. required: - trial_id - status - pool_line_id - pool_line_number - paired_handle - metadata - created_at description: A trial, as the account that started it reads it. securitySchemes: bearerAuth: type: http scheme: bearer description: >- An API key created in the iSnap dashboard, or a trial key, sent as `Authorization: Bearer `. 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. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.