Skip to content

List Bulk Validation Groups

GET
/emails/bulk/groups
 
curl --request GET \
  --url 'https://api.unwrap.email/v1/emails/bulk/groups?page=1&take=25' \
  --header 'UNWRAP-EMAIL-API-TOKEN: <UNWRAP-EMAIL-API-TOKEN>'

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “ Query Parameters ”
page
integer
default: 1 >= 1 <= 1000000
take
integer
default: 25 >= 1 <= 100

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Owned CSV groups, newest first.

Media type application/json
object
items
required
Array<object>
object
id
required
string format: uuid
status
required
string
Allowed values: queued parsing processing finalizing completed partial failed expired
total
required
integer
processed
required
integer
success
required
integer
errors
required
integer
unprocessed
required
integer
failure
required
string | null
result_prefix
required
string | null
download_ready
required
boolean
created_at
required
string format: date-time
updated_at
required
string format: date-time
expires_at
required
string format: date-time
total
required
integer
page
required
integer
take
required
integer
Example 
{
  "items": [
    {
      "status": "queued"
    }
  ]
}

400

Section titled “ 400 ”

Invalid request envelope, pagination, identifier, or header.

401

Section titled “ 401 ”

Valid API authentication is required; submission requires write permission.

403

Section titled “ 403 ”

API-token access requires an active subscription. Submission also requires an active subscription for session and bearer callers.

404

Section titled “ 404 ”

The job does not exist or belongs to another user.

409

Section titled “ 409 ”

Idempotency-Key input mismatch, or CSV is not ready.

410

Section titled “ 410 ”

Job results have expired.

413

Section titled “ 413 ”

Request body exceeds 5 MiB.

429

Section titled “ 429 ”

Three unfinished submissions or unclaimed uploads already exist for this user.

503

Section titled “ 503 ”

Bulk admission is disabled or storage is temporarily unavailable.