List inbox placement test

Requires one of the following scopes: inbox_placement_tests:read, inbox_placement_tests:all, all:read, all:all

GET /api/v2/inbox-placement-tests

List inbox placement test

cURL

curl --request GET \
  --url https://api.instantly.ai/api/v2/inbox-placement-tests \
  --header 'Authorization: Bearer <token>'

200

{
  "items": [
    {
      "id": "019e3bd1-8dcc-7fd4-9f58-8aec318abdf8",
      "organization_id": "019e3bd1-8dcd-74a2-997e-17913d47c742",
      "name": "My Inbox Placement Test",
      "type": 1,
      "sending_method": 1,
      "email_subject": "My Email Subject",
      "email_body": "Hi, this is my email body",
      "emails": [
        "[e-mail]"
      ],
      "recipients": [
        "[e-mail]"
      ],
      "timestamp_created": "2026-05-18T16:00:49.613Z",
      "delivery_mode": 1,
      "description": "This is a test description",
      "schedule": {
        "days": {
          "2": true,
          "3": true
        },
        "timing": {
          "from": "02:30"
        },
        "timezone": "America/Chihuahua"
      },
      "campaign_id": "019e3bd1-8dcd-74a2-997e-17925a7e3937",
      "test_code": "ptid_dP0PJ4oZQAG-ULe-KFR7_",
      "tags": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "text_only": true,
      "recipients_labels": [
        {
          "region": "North America",
          "sub_region": "US",
          "type": "Professional",
          "esp": "Google"
        }
      ],
      "timestamp_next_run": "2026-05-18T16:00:49.613Z",
      "automations": [
        {
          "when": {
            "condition_value": 123
          },
          "then": {
            "webhook_url": "<string>",
            "pause_sending_campaigns_for": 123,
            "pause": true,
            "enable_slow_ramp": true,
            "disable_slow_ramp": true,
            "add_tags": [
              "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            ],
            "remove_tags": [
              "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            ]
          }
        }
      ],
      "status": 1,
      "not_sending_status": "daily_limits_hit"
    }
  ],
  "next_starting_after": "019e3bd1-b5b2-7fd6-be61-4feea3731a0a"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit · integer

The number of items to return

Required range: 1 <= x <= 100

Example:

10

starting_after · string

The ID of the last item in the previous page - used for pagination. You can use the value of the next_starting_after field from the previous response.

Example:

"01956fbd-0eb1-72db-a565-82977a586084"

search · string

Example:

"test"

status · enum<number>

Available options: 1, 2, 3

Example:

1

sort_order · enum<string>

Sort order for the results. Results are always sorted by id (which is timestamp-sorted due to UUIDv7).

Available options: asc, desc

Example:

"desc"

Response

200

application/json

The list of Inbox Placement Test

items · Inbox Placement Test · object[] · required

The list of Inbox Placement Test

Show child attributes

next_starting_after · string

The filter for getting the next items after this one, this could either be a UUID, a timestamp, on an email depending on the specific API

Example:

"019e3bd1-b5b2-7fd6-be61-4feea3731a0a"