Show more

Use to navigate results, ENTER to select one, ESC to close

Type in any word to easily find the endpoint, property or group of operations you are looking for.

API changelog
Download source
  • JSON OpenAPI specification
  • YAML OpenAPI specification
eBizAPI

Topics

  • Introduction
  • Authentication

Endpoints

  • Audit
    • Gets recent deals GET
    • Audit Trail POST
  • Auth
    • Authenticate a user POST
  • Avatar
    • Gets a company logo GET
    • Gets an avatar GET
  • Blog
    • Delete Story DELETE
    • Get Story GET
    • List News Stories GET
    • Save blog post POST
  • Branch
    • Delete Branch DELETE
    • Get branch GET
    • Get company branches GET
    • Save branch POST
    • Branch Locator POST
  • Calendar
    • Add Recipients POST
    • Delete Calendar DELETE
    • Calendar Detail GET
    • List Calendar Events GET
    • Get Calendar Recipients GET
    • Remove Calendar recipient DELETE
    • Save Calendar POST
  • Campaign
    • Add Campaign Recipient POST
    • Delete Campaign DELETE
    • Get Campaigns POST
    • Get Recipients GET
    • Remove Campaign Recipient DELETE
    • Save Campaign POST
    • Send Campaign POST
  • Cmt
    • View CMT GET
    • Save CMT POST
  • Comment
    • Add Comment POST
    • Delete Comment DELETE
    • Get related comments GET
    • Upload Comment Attachment POST
  • Company
    • DELETE /api/company/delete DELETE
    • Gets a company GET
    • Gets companies GET
    • Saves a company POST
  • Contact
    • Archive Contact POST
    • Boot User POST
    • Gets current user GET
    • Delete Contact DELETE
    • Gets a user GET
    • Get Contact Settings GET
    • Gets all users from company GET
    • Gets all users of type GET
    • List Contact GET
    • Get Query List GET
    • Get Query Results GET
    • Remove Permissions DELETE
    • Reset Password POST
    • Saves a user POST
    • Save Contact Settings POST
  • Documents
    • Approve Document POST
    • List Folder Documents GET
    • Save a folder POST
    • Clone POST
    • Delete DELETE
    • Delete Folder DELETE
    • Document Detail GET
    • Download Document GET
    • View Document GET
    • Reject Document POST
    • List Related Documents GET
    • Save Document POST
    • Search Documents POST
    • Gets a document thumbnail GET
    • Unpack Zip file Related Documents POST
    • Upload POST
  • Email
    • Download POST
    • Get Attachments GET
    • Get Email GET
    • Get Emails GET
  • Export
    • GET /api/export/branches GET
    • GET /api/export/companies GET
    • GET /api/export/contacts GET
    • GET /api/export/grebates GET
    • GET /api/export/psas GET
  • Feed
    • Get feed items GET
  • Groups
    • Add to Group POST
    • Create Group POST
    • Delete Group DELETE
    • Delete From Tree DELETE
    • Get Group GET
    • Get List of groups GET
    • Move Group in Tree POST
    • Rename Group POST
    • Save Group Meta POST
    • Get Static Groups GET
    • Get Group Tree GET
  • Notifications
    • POST /api/notifications/dismissAllNotifications POST
    • POST /api/notifications/dismissNotification POST
    • GET /api/notifications/getINotifications GET
    • GET /api/notifications/getRecentNotifications GET
  • Open ai
    • Document Summary GET
    • Summary Text GET
  • Pim
    • Gets PIM Calendar GET
    • Delete Export Template DELETE
    • Get Import Mappings File GET
    • Save POST
    • Upload POST
    • Validate File POST
  • Psa
    • Get deals related to a contact or company GET
    • Get deal GET
    • Get deals within a specific category GET
  • Rebate
    • Rebate Deal Earnings GET
    • Rebate Detail GET
    • Rebate Summary Data POST
  • Spend
    • Get Spend GET
    • Query Spend POST
Powered by Bump.sh
API changelog
Download source
  • JSON OpenAPI specification
  • YAML OpenAPI specification
eBizAPI

List Related Documents

Ask AI
  • Open in ChatGPT
  • Open in Claude

  • View as Markdown
  • Copy as Markdown
GET /api/documents/related
Api key

Return a list of documents related to a company, deal, contact, etc.

Query parameters

  • type string Required

    Relationship type: i.e deal, company, contact

  • id string Required

    Related ID

  • docreate string

    Create document folders if they do not exist

Responses

  • default application/json

    Category Response

    Hide response attributes Show response attributes object
    • FOLDERS array[object]
      Hide FOLDERS attributes Show FOLDERS attributes object
      • pathTree string
      • validTo string(date-time)
      • relatedID integer
      • timeSensitive boolean
      • validFrom string(date-time)
      • idTree string
      • parentID integer
      • webDavAccess boolean
      • id integer
      • modified string(date-time)
      • name string
      • relatedType string
    • DOCUMENTS array[object]
      Hide DOCUMENTS attributes Show DOCUMENTS attributes object
      • filetype string
      • shortDescription string
      • validTo integer(date-time)
      • pathTree string
      • created string(date-time)
      • validFrom integer(date-time)
      • relatedID integer
      • timeSensitive boolean
      • categoryID integer
      • createdBy integer
      • showThumbnail boolean
      • modifiedBy integer
      • idTree string
      • processed boolean
      • preventDownload boolean
      • status string
      • webDavAccess boolean
      • size integer
      • modified integer(date-time)
      • id integer
      • name string
      • copied boolean
      • description string
      • relatedType string
GET /api/documents/related
curl \
 --request GET 'http://api.example.com/api/documents/related?type=string&id=string' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (default)
{
  "FOLDERS": [
    {
      "pathTree": "string",
      "validTo": "2025-05-04T09:42:00Z",
      "relatedID": 42,
      "timeSensitive": true,
      "validFrom": "2025-05-04T09:42:00Z",
      "idTree": "string",
      "parentID": 42,
      "webDavAccess": true,
      "id": 42,
      "modified": "2025-05-04T09:42:00Z",
      "name": "string",
      "relatedType": "blog"
    }
  ],
  "DOCUMENTS": [
    {
      "filetype": "xlsx",
      "shortDescription": "string",
      "validTo": 42,
      "pathTree": "string",
      "created": "2025-05-04T09:42:00Z",
      "validFrom": 42,
      "relatedID": 42,
      "timeSensitive": true,
      "categoryID": 42,
      "createdBy": 42,
      "showThumbnail": true,
      "modifiedBy": 42,
      "idTree": "string",
      "processed": true,
      "preventDownload": true,
      "status": "active",
      "webDavAccess": true,
      "size": 42,
      "modified": 42,
      "id": 42,
      "name": "string",
      "copied": true,
      "description": "file description",
      "relatedType": "string"
    }
  ]
}