Find and list contacts: search text, a saved segment, a tag or rules

Before you call

Credential

Authorization: Bearer $KEY

Scope

contacts:read

Graphql

Query.contactsContactList

Sdk

contacts.contact.list

Cli

contacts contact list

Parameters

• limitinteger
  In the query
• afterstring
  In the query
• qstring
  In the query
• segmentIdstring (uuid)
  In the query
• tagstring
  In the query
• totalstring
  In the query

Responses

• 200application/json
  Success
  • itemslist of objectrequired
    • idstringrequired
    • namestringrequired
    • firstNamestring or nullrequired
    • lastNamestring or nullrequired
    • emailstring or nullrequired
    • phonestring or nullrequired
    • companyIdstring or nullrequired
    • ownerstring or nullrequired
    • lifecyclestringrequired
    • sourcestringrequired
    • tagslist of stringrequired
    • suppressedlist of stringrequired
    • lastActivityAtstring or nullrequired
    • createdAtstringrequired
    • updatedAtstringrequired
  • nextstring or nullrequired
  • totalnumber
• 400application/json
  The request was malformed
  • errorstringrequired
  • messagestring
• 401application/json
  No valid credential
  • errorstringrequired
  • messagestring
• 403application/json
  The credential lacks the scope, origin or address
  • errorstringrequired
  • messagestring
• 429application/json
  Over the key's rate limit; see Retry-After
  • errorstringrequired
  • messagestring