Skip to main content
POST
/
threads
/
search
JavaScript
import AIInbx from 'aiinbx';

const client = new AIInbx({
  apiKey: 'My API Key',
});

const response = await client.threads.search();

console.log(response.pagination);
{
  "threads": [
    {
      "id": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "subject": "<string>",
      "snippet": "<string>",
      "lastEmailAt": "<string>",
      "participantEmails": [
        "<string>"
      ],
      "emailCount": 123
    }
  ],
  "pagination": {
    "total": 123,
    "limit": 123,
    "offset": 123,
    "hasMore": true
  }
}

Authorizations

Authorization
string
header
required

API Key authentication using Bearer token

Body

application/json
limit
number
default:20
Required range: 1 <= x <= 100
offset
number
default:0
Required range: x >= 0
createdAfter
string
createdBefore
string
lastEmailAfter
string
lastEmailBefore
string
hasParticipantEmails
string<email>[]
hasEmailFromAddress
string<email>
hasEmailToAddress
string<email>
subjectContains
string
someEmailHasStatus
enum<string>
Available options:
DRAFT,
QUEUED,
ACCEPTED,
SENT,
RECEIVED,
FAILED,
BOUNCED,
COMPLAINED,
REJECTED,
READ,
ARCHIVED
someEmailHasDirection
enum<string>
Available options:
INBOUND,
OUTBOUND
conversationState
enum<string>
Available options:
awaiting_reply,
needs_reply,
active,
stale
staleThresholdDays
number
default:7
Required range: 1 <= x <= 365
sortBy
enum<string>
default:lastEmailAt
Available options:
createdAt,
lastEmailAt,
subject
sortOrder
enum<string>
default:desc
Available options:
asc,
desc

Response

Successful response

threads
object[]
required
pagination
object
required