v1

latestOpenAPI 3.1.02026-07-2617125852.3 KB

DFYEmailAccountOrder

List DFY ordered email accounts

This endpoint will return a list of DFY email accounts ordered

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

get/api/v2/dfy-email-account-orders/accounts

Query parameters

limitinteger

Example:10

The number of items to return

starting_afterstring

Example:01956fbd-0eb1-72db-a565-82977a586084

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.

with_passwordsboolean

Example:true

Whether to include passwords in the response

Response

The list of accounts

next_starting_afterstring

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 response

{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "domain": "example.com",
      "email": "user@example.com",
      "email_provider": 1,
      "first_name": "John",
      "last_name": "Doe",
      "is_pre_warmed_up": true,
      "timestamp_cancelled": "2025-01-01T00:00:00.000Z",
      "timestamp_created": "2025-01-01T00:00:00.000Z",
      "password": "password"
    }
  ],
  "next_starting_after": "123e4567-e89b-12d3-a456-426614174000:2025-01-01T00:00:00.000Z"
}