Skip to content
Pidgely Docs

API reference · Emails

List an email's attachments

GEThttps://api.pidgely.com/emails/{email_id}/attachments
View as Markdown

Lists the attachments of a sent email. Each item has a signed download_url that expires after one hour.

Authorization: Bearer pdg_…. An API key with full_access. A sending_access key gets 401 restricted_api_key.

Path parameters

Name Type Required Description
email_id string Yes Email id UUID.

Request

Node.js
import { Pidgely } from 'pidgely';

const pidgely = new Pidgely(process.env.PIDGELY_API_KEY);

const { data, error } = await pidgely.emails.attachments.list({
  emailId: '0199d8a2-6f3c-7c51-9e2a-3b1f0c6d4e21',
});
console.log(data ?? error);
Python
import os
import pidgely

pidgely.api_key = os.environ["PIDGELY_API_KEY"]

result = pidgely.Emails.Attachments.list({
    "email_id": "0199d8a2-6f3c-7c51-9e2a-3b1f0c6d4e21",
})
print(result)
PHP
<?php

require __DIR__ . '/vendor/autoload.php';

$pidgely = Pidgely::client(getenv('PIDGELY_API_KEY'));

$result = $pidgely->emails->attachments->list([
    'email_id' => '0199d8a2-6f3c-7c51-9e2a-3b1f0c6d4e21',
]);
var_dump($result);
Go
package main

import (
	"context"
	"fmt"
	"os"

	"github.com/pidgely/pidgely-go"
)

func main() {
	ctx := context.Background()
	client := pidgely.NewClient(os.Getenv("PIDGELY_API_KEY"))

	result, err := client.Emails.Attachments.List(ctx, "0199d8a2-6f3c-7c51-9e2a-3b1f0c6d4e21", nil)
	if err != nil {
		panic(err)
	}
	fmt.Println(result)
}
Ruby
require "pidgely"

Pidgely.api_key = ENV["PIDGELY_API_KEY"]

result = Pidgely::Emails::Attachments.list({
  email_id: "0199d8a2-6f3c-7c51-9e2a-3b1f0c6d4e21"
})
puts result
cURL
curl -X GET 'https://api.pidgely.com/emails/0199d8a2-6f3c-7c51-9e2a-3b1f0c6d4e21/attachments' \
  -H "Authorization: Bearer $PIDGELY_API_KEY"

Response

200 OK

JSON
{
  "object": "list",
  "has_more": false,
  "data": [
    {
      "object": "attachment",
      "id": "0199d8a2-6f41-7a8e-b1c3-2d7e9f05a6c4",
      "filename": "invoice.pdf",
      "size": 48213,
      "content_type": "application/pdf",
      "content_disposition": "attachment",
      "content_id": null,
      "download_url": "https://api.pidgely.com/files/attachments/…",
      "expires_at": "2026-10-12T17:44:41Z"
    }
  ]
}

Response fields

Name Type Required Description
object string Yes Object type. One of list.
has_more boolean Yes Whether another page exists.
data object[] Yes Items of this page.
data[].object string No Object type.
data[].id string No Unique id (UUID). UUID.
data[].filename string No —
data[].size integer No —
data[].content_type string No —
data[].content_disposition string No One of attachment, inline.
data[].content_id string | null No —
data[].download_url string No Signed link, valid for 1 hour.
data[].expires_at string No —

Errors

Errors have the shape {"statusCode", "name", "message"}. See Errors for the full list.

Status Name When
401 missing_api_key, restricted_api_key No Authorization: Bearer header, or a sending_access key called an endpoint that needs full_access.
403 invalid_api_key, validation_error The API key is invalid or revoked, or the request is not allowed for this account (unverified domain, plan limit, paused account).
404 not_found The resource does not exist in this account (or the id is not a valid UUID).
422 validation_error A field is missing or invalid; message names it.
429 rate_limit_exceeded Too many requests per second. Wait for Retry-After seconds.