Gojiberry AI Contacts API

openapi: 3.2.0
info:
  title: Gojiberry AI - External Contacts API
  description: '# Gojiberry AI External API


    This API allows you to programmatically access your Gojiberry AI data and integrate it with your applications.'
  version: '1.0'
  contact: {}
servers: []
tags:
- name: Contacts
paths:
  /v1/contact:
    post:
      operationId: ContactExternalController_create
      parameters:
      - name: x-impersonate-user-id
        in: header
        description: ID of an organization member to act on behalf of. The API key user must be the owner of the organization and the target user must belong to the same organization.
        required: false
        schema:
          type: string
      requestBody:
        required: true
        description: Contact data to create. firstName and lastName are required, all other fields are optional.
        content:
          application/json:
            schema:
              type: object
              required:
              - firstName
              - lastName
              - profileUrl
              properties:
                firstName:
                  type: string
                  example: John
                  description: First name of the contact
                lastName:
                  type: string
                  example: Doe
                  description: Last name of the contact
                profileBaseline:
                  type: string
                  description: Profile baseline information
                location:
                  type: string
                  example: New York, NY
                  description: Location of the contact
                jobTitle:
                  type: string
                  example: Software Engineer
                  description: Job title of the contact
                positionDates:
                  type: string
                  example: 2020 - Present
                  description: Position dates information
                company:
                  type: string
                  example: Tech Corp
                  description: Company name
                companySize:
                  type: string
                  example: 51-200
                  description: Company size
                companyUrl:
                  type: string
                  example: https://www.linkedin.com/company/gojiberryai
                  description: LinkedIn Company URL
                website:
                  type: string
                  example: https://johndoe.com
                  description: Website URL
                industry:
                  type: string
                  example: Technology
                  description: Industry
                email:
                  type: string
                  example: john@example.com
                  description: Primary email address
                phone:
                  type: string
                  example: '+1234567890'
                  description: Primary phone number
                profileId:
                  type: string
                  description: LinkedIn profile ID, eg. ACoAABcwGZ0BPKyEbC2o13Qq7MhrAaD
                profileUrl:
                  type: string
                  example: https://linkedin.com/in/johndoe
                  description: LinkedIn profile URL
                picture:
                  type: string
                  description: Profile picture URL
                linkedinIdentifier:
                  type: string
                  description: LinkedIn identifier for the profile. eg. johndoe
                intent:
                  type: string
                  description: Intent or activity description for the contact
                note:
                  type: string
                  description: Additional notes about the contact
                user_note:
                  type: string
                  description: Internal notes about the contact
                agentId:
                  type: number
                  description: Associated agent ID
                listId:
                  type: number
                  description: Associated list ID. Useful to add a contact directly in a campaign.
      responses:
        '201':
          description: Contact successfully created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Contact'
        '400':
          description: Contact already excluded or already exists
      security:
      - bearer: []
      summary: Create a new contact
      tags:
      - Contacts
    get:
      description: Retrieve contacts with optional pagination, search, and filtering options
      operationId: ContactExternalController_findMany
      parameters:
      - name: x-impersonate-user-id
        in: header
        description: ID of an organization member to act on behalf of. The API key user must be the owner of the organization and the target user must belong to the same organization.
        required: false
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: Page number (starts from 1)
        schema:
          type: number
      - name: limit
        required: false
        in: query
        description: 'Number of contacts per page (default: 20)'
        schema:
          type: number
      - name: search
        required: false
        in: query
        description: Search term for firstName, lastName, email, company, website, location, or jobTitle
        schema:
          type: string
      - name: agent
        required: false
        in: query
        description: Filter by agent id
        schema:
          type: string
      - name: dateFrom
        required: false
        in: query
        description: Filter contacts created from this date (YYYY-MM-DD or YYYY-MM-DDTHH:MM)
        schema:
          type: string
      - name: dateTo
        required: false
        in: query
        description: Filter contacts created until this date (YYYY-MM-DD or YYYY-MM-DDTHH:MM)
        schema:
          type: string
      - name: scoreFrom
        required: false
        in: query
        description: Filter contacts with total scoring >= this value (0-3 range)
        schema:
          type: number
      - name: scoreTo
        required: false
        in: query
        description: Filter contacts with total scoring <= this value (0-3 range)
        schema:
          type: number
      - name: intentType
        required: false
        in: query
        description: Filter contacts with intent type
        schema:
          type: string
      - name: listId
        required: false
        in: query
        description: Filter contacts by list id
        schema:
          type: number
      responses:
        '200':
          description: List of contacts with pagination information
          content:
            application/json:
              schema:
                type: object
                properties:
                  contacts:
                    type: array
                    items:
                      $ref: '#/components/schemas/Contact'
                  total:
                    type: number
                    description: Total number of contacts
                  page:
                    type: number
                    description: Current page number
                  limit:
                    type: number
                    description: Number of contacts per page
                  totalPages:
                    type: number
                    description: Total number of pages
      security:
      - bearer: []
      summary: Get all contacts with pagination and filtering
      tags:
      - Contacts
  /v1/contact/{id}:
    patch:
      operationId: ContactExternalController_update
      parameters:
      - name: x-impersonate-user-id
        in: header
        description: ID of an organization member to act on behalf of. The API key user must be the owner of the organization and the target user must belong to the same organization.
        required: false
        schema:
          type: string
      - name: id
        required: true
        in: path
        schema:
          type: number
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateContactExternalDto'
      responses:
        '200':
          description: Contact successfully updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Contact'
        '404':
          description: Contact not found
      security:
      - bearer: []
      summary: Update a contact
      tags:
      - Contacts
    get:
      operationId: ContactExternalController_findOne
      parameters:
      - name: x-impersonate-user-id
        in: header
        description: ID of an organization member to act on behalf of. The API key user must be the owner of the organization and the target user must belong to the same organization.
        required: false
        schema:
          type: string
      - name: id
        required: true
        in: path
        schema:
          type: number
      responses:
        '200':
          description: Get one contact
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Contact'
      security:
      - bearer: []
      summary: Get one contact
      tags:
      - Contacts
  /v1/contact/list/{listId}/contacts:
    post:
      operationId: ContactExternalController_addManyToList
      parameters:
      - name: x-impersonate-user-id
        in: header
        description: ID of an organization member to act on behalf of. The API key user must be the owner of the organization and the target user must belong to the same organization.
        required: false
        schema:
          type: string
      - name: listId
        required: true
        in: path
        schema:
          type: number
      requestBody:
        required: true
        description: List of contact IDs to add to the list.
        content:
          application/json:
            schema:
              type: object
              required:
              - contactIds
              properties:
                contactIds:
                  type: array
                  items:
                    type: number
                  description: Array of contact IDs to add
      responses:
        '200':
          description: Contacts successfully added to the list
      security:
      - bearer: []
      summary: Add contacts to a list
      tags:
      - Contacts
    delete:
      operationId: ContactExternalController_removeManyFromList
      parameters:
      - name: x-impersonate-user-id
        in: header
        description: ID of an organization member to act on behalf of. The API key user must be the owner of the organization and the target user must belong to the same organization.
        required: false
        schema:
          type: string
      - name: listId
        required: true
        in: path
        schema:
          type: number
      requestBody:
        required: true
        description: List of contact IDs to remove from the list.
        content:
          application/json:
            schema:
              type: object
              required:
              - contactIds
              properties:
                contactIds:
                  type: array
                  items:
                    type: number
                  description: Array of contact IDs to remove
      responses:
        '200':
          description: Contacts successfully removed from the list
      security:
      - bearer: []
      summary: Remove contacts from a list
      tags:
      - Contacts
  /v1/contact/intent-type-counts:
    get:
      operationId: ContactExternalController_getIntentTypeCounts
      parameters:
      - name: x-impersonate-user-id
        in: header
        description: ID of an organization member to act on behalf of. The API key user must be the owner of the organization and the target user must belong to the same organization.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Contact counts grouped by intent type
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    intentType:
                      type: string
                      description: The intent type
                    count:
                      type: number
                      description: Number of contacts with this intent type
      security:
      - bearer: []
      summary: Get contact counts by intent type
      tags:
      - Contacts
  /v1/contact/{id}/enrich/email:
    post:
      description: Attempts to find a verified email for the given contact. Each email enrichment that returns an email consumes 1 credit; failed enrichments do not consume any credit.
      operationId: ContactExternalController_enrichEmail
      parameters:
      - name: x-impersonate-user-id
        in: header
        description: ID of an organization member to act on behalf of. The API key user must be the owner of the organization and the target user must belong to the same organization.
        required: false
        schema:
          type: string
      - name: id
        required: true
        in: path
        schema:
          type: number
      responses:
        '200':
          description: Contact updated with the enriched email
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Contact'
        '404':
          description: Contact not found
        '422':
          description: No email could be found for this contact (no credit consumed)
      security:
      - bearer: []
      summary: Enrich a contact's email
      tags:
      - Contacts
components:
  schemas:
    Agent:
      type: object
      properties:
        id:
          type: number
          description: Unique identifier
        name:
          type: string
          description: Display name of the agent
        targetJobTitles:
          description: List of target job titles to prospect. Part of the ICP.
          type: array
          items:
            type: string
        targetIndustries:
          description: List of target industries to prospect. Part of the ICP.
          type: array
          items:
            type: string
        targetCompanySizes:
          description: List of target company sizes (e.g. "1-10", "11-50"). Part of the ICP.
          type: array
          items:
            type: string
        targetLocations:
          description: List of target geographic locations. Part of the ICP.
          type: array
          items:
            type: string
        targetCompanyTypes:
          description: List of target company types (e.g. "Public", "Private")
          type: array
          items:
            type: string
        additionalCriteria:
          type:
          - string
          - 'null'
          description: Additional free-text targeting criteria
        variables:
          description: Variables used by the agent to find high intent leads. (Keywords, Competitor Page URL, etc.)
          type:
          - array
          - 'null'
          items:
            type: string
        ignoredCompanies:
          description: Company names to exclude from prospecting. Part of the ICP.
          type:
          - array
          - 'null'
          items:
            type: string
        mandatoryKeywords:
          description: Keywords that must be present in a lead profile to be included
          type:
          - array
          - 'null'
          items:
            type: string
        agentType:
          type: string
          description: 'Type of agent: "autopilot", "lookalike" or "website-visitor"'
          example: autopilot
        scriptInstalled:
          type: boolean
          description: Whether the visitor tracking script is installed on the website (website-visitor agents)
          default: false
        maxCreditUsage:
          type:
          - number
          - 'null'
          description: Max number of credits per month
          example: 200
        lastRun:
          format: date-time
          type:
          - string
          - 'null'
          description: Timestamp of the last agent execution
        paused:
          type: boolean
          description: Whether the agent is paused and will not run on its next scheduled time
          default: false
        excludeServiceProviders:
          type: boolean
          description: Whether to exclude service provider companies from prospecting
          default: false
        skipIcpFilter:
          type: boolean
          description: Whether to skip the ICP (Ideal Customer Profile) filter when sourcing leads
          default: false
        includeOpenToWorkProfiles:
          type: boolean
          description: Whether to include LinkedIn profiles marked as open to work
          default: false
        leadWaterfall:
          type: boolean
          description: Whether to use the lead waterfall strategy (cascade through multiple sources)
          default: true
        minLeadScore:
          type:
          - number
          - 'null'
          description: Minimum lead score threshold (0.00–1.00) required to include a lead
          example: 0.75
        userId:
          type: number
          description: ID of the account (user) who owns this agent
        listId:
          type:
          - number
          - 'null'
          description: ID of the list this agent sources contacts into
        createdAt:
          format: date-time
          type: string
          description: Creation timestamp
        updatedAt:
          format: date-time
          type: string
          description: Last update timestamp
      required:
      - id
      - name
      - targetJobTitles
      - targetIndustries
      - targetCompanySizes
      - targetLocations
      - targetCompanyTypes
      - agentType
      - scriptInstalled
      - paused
      - excludeServiceProviders
      - skipIcpFilter
      - includeOpenToWorkProfiles
      - leadWaterfall
      - userId
      - createdAt
      - updatedAt
    Contact:
      type: object
      properties:
        id:
          type: number
          description: Unique identifier for the contact
        firstName:
          type: string
          description: First name of the contact
        lastName:
          type: string
          description: Last name of the contact
        fullName:
          type: string
          description: Full name (auto-generated from firstName and lastName)
          readOnly: true
        profileBaseline:
          type: string
          description: Profile baseline information
        location:
          type: string
          description: Location of the contact
        jobTitle:
          type: string
          description: Job title of the contact
        positionDates:
          type: string
          description: Position dates information
        company:
          type: string
          description: Company name
        companySize:
          type: string
          description: Company size
        companyUrl:
          type: string
          description: Company URL
        website:
          type: string
          description: Website URL
        industry:
          type: string
          description: Industry
        email:
          type: string
          description: Primary email address
        email_2:
          type: string
          description: Secondary email address
        email_3:
          type: string
          description: Tertiary email address
        secondEmail:
          type: string
          description: Second email alias
        thirdEmail:
          type: string
          description: Third email alias
        phone:
          type: string
          description: Primary phone number
        phone_2:
          type: string
          description: Secondary phone number
        phone_3:
          type: string
          description: Tertiary phone number
        secondPhone:
          type: string
          description: Second phone alias
        thirdPhone:
          type: string
          description: Third phone alias
        profileId:
          type: string
          description: LinkedIn profile ID
        linkedinMemberId:
          type: number
          description: Numeric LinkedIn member ID decoded from the profile URN
        profileUrl:
          type: string
          description: LinkedIn profile URL
        picture:
          type: string
          description: Profile picture URL
        openToWork:
          type: boolean
          description: Open to work status
        skills:
          description: Array of skills
          type: array
          items:
            type: string
        linkedinIdentifier:
          type: string
          description: LinkedIn identifier for the profile
        note:
          type: string
          description: Additional notes about the contact
        user_note:
          type: string
          description: User personal notes about the contact
        intent:
          type: string
          description: Intent or activity description
        intent_scoring:
          type: number
          description: AI scoring for intent relevance between 0 and 3
        total_scoring:
          type: number
          description: Total scoring (intent_scoring + scoring)
        intent_type:
          type: object
          description: Type or category of the intent
        intent_keyword:
          type: string
          description: Keyword extracted from the intent
        scoring:
          type: number
          description: AI scoring result between 0 and 1 (0 = no match, 1 = perfect match)
        score_reasoning:
          type: string
          description: Reasoning for the AI scoring result
        bounced:
          type: boolean
          description: Whether the contact email has bounced
          default: false
        unsubscribed:
          type: boolean
          description: Whether the contact has unsubscribed from emails
          default: false
        redListed:
          type: boolean
          description: Whether the contact is on the global GDPR red list (do-not-contact)
          default: false
        blocked:
          type: boolean
          description: Whether the contact matches the organization people blocklist
          default: false
        emailEnriched:
          type: boolean
          description: Whether email has been enriched
          default: false
        phoneEnriched:
          type: boolean
          description: Whether phone has been enriched
          default: false
        fit:
          type: string
          description: Contact fit classification
          enum:
          - qualified
          - unknown
          - out-of-scope
        email_template:
          type: object
          description: Email template in JSON format with subject and body
        linkedin_template:
          type: string
          description: LinkedIn template text
        personalizedMessages:
          description: Personalized messages for the contact
          type: array
          items:
            type: string
        destinationStatus:
          description: Destination sync status information
          type: array
          items:
            type: string
        campaignStatus:
          description: Campaign status information. Useful to know what is the achieved step of the contact in the campaign — i.e. how far the contact has progressed through the campaign's sequence. The stepNumber matches the campaign's step numbers (the steps defined on the campaign), so a stepNumber of 2 means the contact has reached step 2 of that campaign.
          type: array
          items:
            type: string
        userId:
          type: number
          description: User ID who owns this contact
        user:
          description: Associated user account
          allOf:
          - $ref: '#/components/schemas/Account'
        agentId:
          type: number
          description: Associated agent ID
        agent:
          description: Associated agent
          allOf:
          - $ref: '#/components/schemas/Agent'
        listId:
          type: number
          description: Associated list ID
        list:
          description: Associated list
          allOf:
          - $ref: '#/components/schemas/List'
        readyForCampaign:
          type: boolean
          description: Ready for campaign flag
          default: false
        hasStartedCampaign:
          type: boolean
          description: Has started campaign flag
          default: false
        state:
          type: string
          description: Contact state
          enum:
          - finished
          - paused
          - 1stnetwork
          - excluded
        createdAt:
          format: date-time
          type: string
          description: Creation timestamp
        updatedAt:
          format: date-time
          type: string
          description: Last update timestamp
      required:
      - id
      - firstName
      - lastName
      - fullName
      - bounced
      - unsubscribed
      - redListed
      - blocked
      - emailEnriched
      - phoneEnriched
      - userId
      - user
      - readyForCampaign
      - hasStartedCampaign
      - createdAt
      - updatedAt
    List:
      type: object
      properties:
        id:
          type: number
          description: Unique identifier for the list
        name:
          type: string
          description: Name of the list
        userId:
          type: number
          description: User ID who owns this list
        user:
          description: Associated user account
          allOf:
          - $ref: '#/components/schemas/Account'
        campaignId:
          type: number
          description: Campaign ID associated with this list
        campaign:
          description: Associated campaign
          allOf:
          - $ref: '#/components/schemas/Campaign'
        createdAt:
          format: date-time
          type: string
          description: Creation timestamp
        updatedAt:
          format: date-time
          type: string
          description: Last update timestamp
      required:
      - id
      - name
      - userId
      - user
      - createdAt
      - updatedAt
    PersonalizedMessageDto:
      type: object
      properties:
        content:
          type: string
          description: Message content for this campaign step
        stepNumber:
          type: number
          description: Campaign step number this message applies to. Please refer to the campaign.steps array !
      required:
      - content
      - stepNumber
    Account:
      type: object
      properties: {}
    Campaign:
      type: object
      properties:
        id:
          type: number
          description: Unique identifier for the campaign
        name:
          type: string
          description: Name of the campaign
        steps:
          type: array
          description: Campaign steps
        userId:
          type: number
          description: User ID who owns this campaign
        active:
          type: boolean
          description: Whether the campaign is active
          default: true
        excludeFirstDegreeFromCampaigns:
          type: boolean
          description: Exclude first degree connections from campaigns
          default: true
        isManual:
          type: boolean
          description: Whether the campaign is manual
          default: false
        skipInvitationAfterDays:
          type: number
          description: Number of days after which a pending invitation is skipped and only email steps are sent
        language:
          type:
          - string
          - 'null'
          description: Campaign language
        tone:
          type: string
          description: Campaign tone
          enum:
          - professional
          - direct
          - conversational
        goal:
          type: string
          description: Campaign goal
          enum:
          - conversations
          - demos
        linkedinSeatId:
          type: number
          description: LinkedIn seat ID for this campaign
        createdAt:
          format: date-time
          type: string
          description: Creation timestamp
        updatedAt:
          format: date-time
          type: string
          description: Last update timestamp
      required:
      - id
      - name
      - userId
      - active
      - excludeFirstDegreeFromCampaigns
      - isManual
      - createdAt
      - updatedAt
    UpdateContactExternalDto:
      type: object
      properties:
        firstName:
          type: string
          description: First name of the contact
        lastName:
          type: string
          description: Last name of the contact
        profileUrl:
          type: string
          description: LinkedIn profile URL
        profileId:
          type: string
          description: LinkedIn profile ID
        profileBaseline:
          type: string
          description: Profile baseline information
        location:
          type: string
          description: Location of the contact
        jobTitle:
          type: string
          description: Job title of the contact
        positionDates:
          type: string
          description: Position dates information
        company:
          type: string
          description: Company name
        companySize:
          type: string
          description: Company size
        companyUrl:
          type: string
          description: LinkedIn company URL
        website:
          type: string
          description: Website URL
        industry:
          type: string
          description: Industry
        email:
          type: string
          description: Primary email address
        picture:
          type: string
          description: Profile picture URL
        openToWork:
          type: boolean
          description: Open to work status
        linkedinIdentifier:
          type: string
          description: LinkedIn identifier for the profile
        intent:
          type: string
          description: Intent or activity description for the contact
        fit:
          type: string
          description: Contact fit classification
          enum:
          - qualified
          - unknown
          - out-of-scope
        state:
          type:
          - string
          - 'null'
          description: 'Contact state. Set to "paused" to stop a contact from progressing in the campaign. Send null to clear the state. Possible values: "paused" (stops campaign progression), "finished" (completed all steps), "1stnetwork" (1st degree LinkedIn connection), "excluded" (excluded from all campaigns), "answered" (replied to a message).'
          enum:
          - finished
          - paused
          - 1stnetwork
          - excluded
          - answered
        personalizedMessages:
          description: Personalized messages for each campaign step.
          type: array
          items:
            $ref: '#/components/schemas/PersonalizedMessageDto'
  securitySchemes:
    API-Key:
      scheme: bearer
      bearerFormat: JWT
      type: http
      name: JWT
      description: Enter API Key
      in: header