API reference / Messaging reads

List sent invitations (live)

Written and maintained by The ProspectAPIs team

GET/v1/invitations/sent

GET /v1/invitations/sent is the ProspectAPIs operation listSentInvitations, in the Messaging reads group of the REST API. Read the connection invitations your connected account sent, each with status (pending, or accepted or withdrawn where known), the invitee as a person and sent_at. $0.01 per read. Billed per call once the messaging reads are live; while they are not yet on sale the call is free (GET /pricing reports messaging_reads.available). Cost: Launching soon. Send your API key as a Bearer token in the Authorization header.

The quickstart shows this call in context, next to the first requests most integrations make.

Parameters

An unknown query parameter is refused with a 400 rather than ignored, so a typo never widens a search you pay for.

Responses

Every error answers with the same JSON body, an error string and sometimes a code; the errors page lists each status and when it happens. A per-key 429 carries Retry-After; see rate limits.

200 response fields

The invitations, read fresh, with coverage. The body is a PeopleReadResult.

Code samples

Each sample sends the same request. Set PROSPECTAPIS_KEY in your environment first. Values come from the spec's examples; replace them with your own.

curl https://api.prospectapis.com/v1/invitations/sent \
  -H "Authorization: Bearer $PROSPECTAPIS_KEY"

const res = await fetch("https://api.prospectapis.com/v1/invitations/sent", {
  headers: { Authorization: `Bearer ${process.env.PROSPECTAPIS_KEY}` },
});
if (!res.ok) throw new Error(`${res.status}: ${(await res.json().catch(() => ({}))).error ?? res.statusText}`);
const data = await res.json();
console.log(data);

import os, requests

res = requests.get(
    "https://api.prospectapis.com/v1/invitations/sent",
    headers={"Authorization": f"Bearer {os.environ['PROSPECTAPIS_KEY']}"},
    timeout=30,
)
res.raise_for_status()
data = res.json()
print(data)

Billing

Billing reserves before it serves: the call holds what it may cost, serves at most what that hold covers, and refunds the rest when the response closes. Any non-2xx answer refunds the whole hold, so a failed call costs nothing. The response reports your balance in X-Credits-Remaining.

Related

Previous operation: List received invitations (live). Next operation: Accept an invitation. Every operation, grouped by area, is on the API reference index.

Create a free account to get a key, then run the samples above with your own values.