api.socialfetch.dev

{
  "description": "Standard success response envelope.",
  "properties": {
    "data": {
      "description": "Endpoint-specific response payload.",
      "properties": {
        "results": {
          "description": "Per-URL organization lookup results.",
          "items": {
            "description": "LinkedIn organization lookup result for one requested URL.",
            "properties": {
              "additionalInformation": {
                "description": "Additional open-roles or hiring summary text when available.",
                "nullable": true,
                "type": "string"
              },
              "affiliatedOrganizations": {
                "description": "Affiliated organization suggestions when available.",
                "items": {
                  "description": "A similar organization suggestion.",
                  "properties": {
                    "industries": {
                      "description": "Industry label when available.",
                      "nullable": true,
                      "type": "string"
                    },
                    "location": {
                      "description": "Location label when available.",
                      "nullable": true,
                      "type": "string"
                    },
                    "name": {
                      "description": "Similar organization name.",
                      "minLength": 1,
                      "type": "string"
                    },
                    "pageUrl": {
                      "description": "LinkedIn page URL for the similar organization.",
                      "minLength": 1,
                      "type": "string"
                    }
                  },
                  "required": [
                    "name",
                    "industries",
                    "location",
                    "pageUrl"
                  ],
                  "type": "object"
                },
                "type": "array"
              },
              "alumniInsights": {
                "description": "Alumni insights for school pages when available.",
                "items": {
                  "description": "Aggregated alumni insight for school pages.",
                  "properties": {
                    "header": {
                      "description": "Section header when available.",
                      "nullable": true,
                      "type": "string"
                    },
                    "label": {
                      "description": "Metric label.",
                      "minLength": 1,
                      "type": "string"
                    },
                    "value": {
                      "description": "Metric value text.",
                      "minLength": 1,
                      "type": "string"
                    }
                  },
                  "required": [
                    "label",
                    "value"
                  ],
                  "type": "object"
                },
                "type": "array"
              },
              "error": {
                "description": "Error details when `lookupStatus` is `error`.",
                "nullable": true,
                "properties": {
                  "message": {
                    "description": "Short customer-safe reason this organization could not be returned.",
                    "minLength": 1,
                    "type": "string"
                  }
                },
                "required": [
                  "message"
                ],
                "type": "object"
              },
              "featuredEmployees": {
                "description": "Featured people shown on the page when available.",
                "items": {
                  "description": "A featured person shown on the organization page.",
                  "properties": {
                    "imageUrl": {
                      "description": "Profile image URL when available.",
                      "nullable": true,
                      "type": "string"
                    },
                    "name": {
                      "description": "Person name.",
                      "minLength": 1,
                      "type": "string"
                    },
                    "profileUrl": {
                      "description": "LinkedIn profile URL when available.",
                      "nullable": true,
                      "type": "string"
                    },
                    "title": {
                      "description": "Role or headline shown on the page.",
                      "nullable": true,
                      "type": "string"
                    }
                  },
                  "required": [
                    "name",
                    "title",
                    "profileUrl",
                    "imageUrl"
                  ],
                  "type": "object"
                },
                "type": "array"
              },
              "funding": {
                "description": "Funding summary when available.",
                "nullable": true,
                "properties": {
                  "investors": {
                    "description": "Investors when available.",
                    "items": {
                      "description": "A funding investor when available.",
                      "properties": {
                        "name": {
                          "description": "Investor name.",
                          "minLength": 1,
                          "type": "string"
                        }
                      },
                      "required": [
                        "name"
                      ],
                      "type": "object"
                    },
                    "type": "array"
                  },
                  "lastRoundDate": {
                    "description": "Most recent funding round date when available.",
                    "nullable": true,
                    "type": "string"
                  },
                  "lastRoundRaised": {
                    "description": "Most recent funding round amount label when available.",
                    "nullable": true,
                    "type": "string"
                  },
                  "lastRoundType": {
                    "description": "Most recent funding round type when available.",
                    "nullable": true,
                    "type": "string"
                  },
                  "rounds": {
                    "description": "Reported number of funding rounds when available.",
                    "minimum": 0,
                    "nullable": true,
                    "type": "integer"
                  }
                },
                "required": [
                  "investors"
                ],
                "type": "object"
              },
              "locations": {
                "description": "Location labels when available.",
                "items": {
                  "description": "A location associated with the organization.",
                  "properties": {
                    "countryCode": {
                      "description": "Country code when available.",
                      "nullable": true,
                      "type": "string"
                    },
                    "label": {
                      "description": "Location label.",
                      "minLength": 1,
                      "type": "string"
                    }
                  },
                  "required": [
                    "label"
                  ],
                  "type": "object"
                },
                "type": "array"
              },
              "lookupStatus": {
                "description": "Whether this organization page was resolved.",
                "enum": [
                  "found",
                  "not_found",
                  "error"
                ],
                "type": "string"
              },
              "metrics": {
                "description": "Organization metrics when available.",
                "nullable": true,
                "properties": {
                  "alumni": {
                    "description": "Alumni count when available.",
                    "minimum": 0,
                    "nullable": true,
                    "type": "integer"
                  },
                  "employeesOnLinkedIn": {
                    "description": "Employees listed on LinkedIn when available.",
                    "minimum": 0,
                    "nullable": true,
                    "type": "integer"
                  },
                  "followers": {
                    "description": "Follower count when available.",
                    "minimum": 0,
                    "nullable": true,
                    "type": "integer"
                  }
                },
                "required": [
                  "followers",
                  "employeesOnLinkedIn",
                  "alumni"
                ],
                "type": "object"
              },
              "organization": {
                "description": "Organization details when available.",
                "nullable": true,
                "properties": {
                  "about": {
                    "description": "About text when available.",
                    "nullable": true,
                    "type": "string"
                  },
                  "countryCode": {
                    "description": "Primary country code when available.",
                    "nullable": true,
                    "type": "string"
                  },
                  "coverImageUrl": {
                    "description": "Cover image URL when available.",
                    "nullable": true,
                    "type": "string"
                  },
                  "crunchbaseUrl": {
                    "description": "Crunchbase profile URL when available.",
                    "nullable": true,
                    "type": "string"
                  },
                  "employeeRange": {
                    "description": "Reported employee range label when available.",
                    "nullable": true,
                    "type": "string"
                  },
                  "foundedYear": {
                    "description": "Founded year when available.",
                    "nullable": true,
                    "type": "integer"
                  },
                  "headquarters": {
                    "description": "Headquarters label when available.",
                    "nullable": true,
                    "type": "string"
                  },
                  "id": {
                    "description": "Organization identifier as a string.",
                    "minLength": 1,
                    "type": "string"
                  },
                  "industries": {
                    "description": "Industry label when available.",
                    "nullable": true,
                    "type": "string"
                  },
                  "logoUrl": {
                    "description": "Logo image URL when available.",
                    "nullable": true,
                    "type": "string"
                  },
                  "name": {
                    "description": "Organization display name.",
                    "minLength": 1,
                    "type": "string"
                  },
                  "organizationType": {
                    "description": "Organization type label when available.",
                    "nullable": true,
                    "type": "string"
                  },
                  "pageType": {
                    "description": "LinkedIn page type for this organization.",
                    "enum": [
                      "company",
                      "school",
                      "organization"
                    ],
                    "type": "string"
                  },
                  "pageUrl": {
                    "description": "Canonical public LinkedIn organization page URL.",
                    "minLength": 1,
                    "type": "string"
                  },
                  "platform": {
                    "description": "Social platform for this record.",
                    "enum": [
                      "linkedin"
                    ],
                    "type": "string"
                  },
                  "slogan": {
                    "description": "Tagline when available.",
                    "nullable": true,
                    "type": "string"
                  },
                  "slug": {
                    "description": "Page vanity slug when available.",
                    "minLength": 1,
                    "type": "string"
                  },
                  "specialties": {
                    "description": "Specialty tags when available.",
                    "items": {
                      "minLength": 1,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "website": {
                    "description": "Primary external website when available.",
                    "nullable": true,
                    "type": "string"
                  },
                  "websiteDomain": {
                    "description": "Root website domain when available.",
                    "nullable": true,
                    "type": "string"
                  }
                },
                "required": [
                  "platform",
                  "pageType",
                  "id",
                  "name",
                  "pageUrl",
                  "about",
                  "website",
                  "logoUrl",
                  "coverImageUrl",
                  "industries",
                  "specialties",
                  "organizationType",
                  "employeeRange",
                  "headquarters"
                ],
                "type": "object"
              },
              "recentPosts": {
                "description": "Recent posts from the organization page when available.",
                "items": {
                  "description": "A recent post from the organization page.",
                  "properties": {
                    "commentsCount": {
                      "description": "Comment count when available.",
                      "minimum": 0,
                      "nullable": true,
                      "type": "integer"
                    },
                    "externalLink": {
                      "description": "External link from the post when available.",
                      "nullable": true,
                      "type": "string"
                    },
                    "likesCount": {
                      "description": "Like count when available.",
                      "minimum": 0,
                      "nullable": true,
                      "type": "integer"
                    },
                    "postId": {
                      "description": "Post identifier when available.",
                      "type": "string"
                    },
                    "postUrl": {
                      "description": "Public URL for the post.",
                      "minLength": 1,
                      "type": "string"
                    },
                    "publishedAt": {
                      "description": "Publication time in ISO-8601 when available.",
                      "nullable": true,
                      "type": "string"
                    },
                    "text": {
                      "description": "Post text when available.",
                      "nullable": true,
                      "type": "string"
                    },
                    "title": {
                      "description": "Author or headline label when available.",
                      "nullable": true,
                      "type": "string"
                    }
                  },
                  "required": [
                    "postUrl",
                    "text"
                  ],
                  "type": "object"
                },
                "type": "array"
              },
              "similarOrganizations": {
                "description": "Similar organization suggestions when available.",
                "items": {
                  "description": "A similar organization suggestion.",
                  "properties": {
                    "industries": {
                      "description": "Industry label when available.",
                      "nullable": true,
                      "type": "string"
                    },
                    "location": {
                      "description": "Location label when available.",
                      "nullable": true,
                      "type": "string"
                    },
                    "name": {
                      "description": "Similar organization name.",
                      "minLength": 1,
                      "type": "string"
                    },
                    "pageUrl": {
                      "description": "LinkedIn page URL for the similar organization.",
                      "minLength": 1,
                      "type": "string"
                    }
                  },
                  "required": [
                    "name",
                    "industries",
                    "location",
                    "pageUrl"
                  ],
                  "type": "object"
                },
                "type": "array"
              },
              "stockInfo": {
                "description": "Stock information when available.",
                "nullable": true,
                "properties": {
                  "exchange": {
                    "description": "Stock exchange when available.",
                    "nullable": true,
                    "type": "string"
                  },
                  "price": {
                    "description": "Stock price label when available.",
                    "nullable": true,
                    "type": "string"
                  },
                  "priceChange": {
                    "description": "Stock price change label when available.",
                    "nullable": true,
                    "type": "string"
                  },
                  "recordedAt": {
                    "description": "Timestamp when stock data was recorded.",
                    "nullable": true,
                    "type": "string"
                  },
                  "ticker": {
                    "description": "Stock ticker when available.",
                    "nullable": true,
                    "type": "string"
                  }
                },
                "type": "object"
              },
              "url": {
                "description": "Requested organization URL echoed for this result.",
                "minLength": 1,
                "type": "string"
              }
            },
            "required": [
              "url",
              "lookupStatus",
              "error",
              "organization",
              "metrics",
              "locations",
              "featuredEmployees",
              "similarOrganizations",
              "affiliatedOrganizations",
              "recentPosts",
              "funding",
              "stockInfo",
              "alumniInsights",
              "additionalInformation"
            ],
            "type": "object"
          },
          "type": "array"
        },
        "summary": {
          "description": "Summary counts for the organization batch.",
          "properties": {
            "errored": {
              "description": "Number of organization pages that failed to resolve.",
              "minimum": 0,
              "type": "integer"
            },
            "found": {
              "description": "Number of organization pages successfully found.",
              "minimum": 0,
              "type": "integer"
            },
            "notFound": {
              "description": "Number of organization pages that were not found.",
              "minimum": 0,
              "type": "integer"
            },
            "requestedUrls": {
              "description": "Number of organization URLs requested in this batch.",
              "minimum": 0,
              "type": "integer"
            }
          },
          "required": [
            "requestedUrls",
            "found",
            "notFound",
            "errored"
          ],
          "type": "object"
        }
      },
      "required": [
        "results",
        "summary"
      ],
      "type": "object"
    },
    "meta": {
      "description": "Metadata describing the request and billing outcome.",
      "properties": {
        "cached": {
          "description": "True when served from shared response cache. Credits still apply (full endpoint price); Age header may be present.",
          "type": "boolean"
        },
        "creditsCharged": {
          "description": "Credits charged for this request.",
          "minimum": 0,
          "type": "integer"
        },
        "requestId": {
          "description": "Unique request identifier for tracing this API call.",
          "minLength": 1,
          "type": "string"
        },
        "version": {
          "description": "Public API version that served the response.",
          "enum": [
            "v1"
          ],
          "type": "string"
        }
      },
      "required": [
        "requestId",
        "creditsCharged",
        "version"
      ],
      "type": "object"
    }
  },
  "required": [
    "data",
    "meta"
  ],
  "type": "object"
}