Skip to main content

GET /seedlisting

GET 
seedlisting

Retrieve all seedlisting inbox placement tests for the current user

Query Parameters​

offset string
Number of items to skip before starting to return results

limit string
Maximum number of items to return per request

title string
Filter by title substring

profile_id string
Filter by profile ID

show_all boolean
Admin-only. When true, includes the user_email field in each result

Returns

  • dataarray
    • idstring
      Unique identifier of the seedlisting test
    • titlestring
      Name of the seedlisting test
    • profile_idstring
      Profile ID associated with this seedlisting test
    • statusstring
      Current status of the seedlisting test
      Allowed values: INIT, ACTIVE, DONE, FAILED, TERMINATED
    • check_typestring
      Type of seedlisting check to perform, which determines the method of matching incoming emails
      Allowed values: TAG, H_TO, REF, EXPRESS
    • created_atstring
      Timestamp when the seedlisting test was created
    • updated_atstring
      Timestamp when the seedlisting test was last updated
    • tagstring
      Tag identifier used to match incoming emails; present only when check_type is TAG
    • email_ref_addrstring
      Reference email address used for routing; present only when check_type is REF
    • statsobject
      Aggregated delivery statistics for this seedlisting test
      • inboxnumber
        Number of emails delivered to the inbox
      • spamnumber
        Number of emails delivered to the spam or junk folder
      • waitingnumber
        Number of emails pending delivery results
      • not_receivednumber
        Number of emails not received
    • user_emailstring
      Email of the user that created the seedlisting test, present only if the requester is an ADMIN and show_all=true
  • metaobject
    Pagination metadata for list responses
    • countinteger
      Total number of items available
    • offsetinteger
      Number of items skipped
    • limitinteger
      Maximum number of items returned per request
Error Codes

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

500 Internal Server Error

Internal server error