Read a test user's inbox

GET

domains

{domainId}

test-users

{userId}

inbox

Error

A valid request URL is required to generate request examples

{
  "messages": [
    {
      "id": "<string>",
      "from": "<string>",
      "subject": "<string>",
      "received_at": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

Authorizations

Authorization

string

header

required

API token obtained from the Tokens endpoint. Include as Authorization: Bearer <token>.

Path Parameters

domainId

string<uuid>

required

Domain id.

userId

string<uuid>

required

Test user id.

Query Parameters

limit

integer

Max messages (default 25).

Response

Inbox messages.

messages

object[]

Show child attributes

Read a single inbox messageReturns the full message body as readable text (HTML converted to text so OTP codes and magic-link URLs are preserved).

Error

A valid request URL is required to generate request examples

{
  "messages": [
    {
      "id": "<string>",
      "from": "<string>",
      "subject": "<string>",
      "received_at": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

Scans

Audit

Vulnerabilities

Assets

Schedules

Tokens

Webhooks

Organization

Members

Invitations

Analytics

Connectors

Chat

PR Reviews

Knowledge

Integrations

Uploads

Test Users

Read a test user's inbox

Authorizations

Path Parameters

Query Parameters

Response