Skip to main content

list contacts

GET 
/org/:orgId/contact

List all contacts under the given organization. If contactIds parameter is provided, return only those specific contacts.

Request​

Path Parameters

    orgId stringrequired

    Organization ID

Query Parameters

    contactIds string

    Comma-separated list of contact IDs to fetch specific contacts, up to 100 IDs

    emailDomain string

    Email domain to filter contacts

    keyword string

    the keyword string to search contacts by name or email (uses ORM for better performance)

    limit integer

    List pagination size, default 1000, max value is 1000 (ignored when contactIds is provided)

    offset integer

    List pagination offset, default 0 (ignored when contactIds is provided)

Responses​

OK

Schema

  • Array [

    • companyContactId string
    creationTime string
    emailAddress string
    id string

    This is generated by Suger. When you create a new contact, do not provide.

    info

    object

    companyLocation string
    companyName string

    enrichedContactInfo

    object

    city string
    companyDomain string
    companyName string

    Company information

    country string

    Location information

    creationTime string

    Timestamps

    email string

    Contact information

    firstName string
    id string

    Core identification fields

    info

    object

    Additional structured information

    workExperiences

    object[]

  • Array [

    • current boolean

    true if the work experience is current

    endDate string
    organizationName string
    startDate string
    title string

  • ]

    • jobFunction string
    jobTitle string

    Professional information

    lastName string
    lastUpdateTime string
    linkedIn string
    name string
    phone string
    s3KeyPicture string

    Media and social

    status EnrichmentDataStatus (string)

    Possible values: [active, stale, archived]

    active/stale/archived

    twitter string
    lastModifiedBy string
    partner Partner (string)

    Possible values: [``, ADYEN, ALIBABA, ANTHROPIC, AWS, AWS_CHINA, AZURE, CHARGEBEE, DATABRICKS, DOCUSIGN, GCP, GOOGLE, HUBSPOT, INTUIT, LAGO, MARKETO, METRONOME, MICROSOFT, OPENAI, ORACLE, ORB, REDHAT, SALESFORCE, SLACK, SNOWFLAKE, STRIPE, ZOHO]

    phoneNumber string
    role string
    lastUpdateTime string
    name string
    organizationID string

  • ]

Loading...