PayMongo HomeGuidesAPI ReferenceStart Building
API Reference

List contacts

get
https://sales-api.paymongo.com/v1/internal/contacts
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Workspace organization ID

string

Cursor

integer

Limit (1–50)

ids
array of strings

Comma-separated or repeated contact IDs (match any)

ids
string

Email substring search

string

created_at | last_contacted_at (default created_at)

string

asc | desc (default desc)

organization_ids
array of strings

Comma-separated or repeated organization IDs linked via organization_contact

organization_ids
deal_ids
array of strings

Comma-separated or repeated deal IDs linked via deal_contact

deal_ids
lead_ids
array of strings

Comma-separated or repeated lead IDs linked via lead_contact

lead_ids
tag_ids
array of strings

Comma-separated or repeated tag IDs linked via contact_tag

tag_ids
ticket_ids
array of strings

Comma-separated or repeated ticket IDs linked via contact_ticket

ticket_ids
owner_ids
array of strings

Comma-separated or repeated record owner IDs (metadata.owner on contact-api; match any)

owner_ids
status
array of strings

Comma-separated or repeated metadata.status values (new, attempted_to_contact, connected, qualified, unqualified, marketingqualifiedlead, customer, lead, subscriber, salesqualifiedlead, other)

status
string

Filter metadata.last_contacted_at >= (ISO 8601)

string

Filter metadata.last_contacted_at <= (ISO 8601)

string

Created at lower bound (RFC3339)

string

Created at upper bound (RFC3339)

Responses

Updated 2 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago

Did this page help you?