api.socialfetch.dev

{
  "description": "Standard success response envelope.",
  "properties": {
    "data": {
      "description": "Endpoint-specific response payload.",
      "properties": {
        "jobs": {
          "description": "Job listings matching the search criteria.",
          "items": {
            "description": "One job listing from a LinkedIn job search.",
            "properties": {
              "applicantCount": {
                "description": "Number of applicants for the job.",
                "minimum": 0,
                "nullable": true,
                "type": "integer"
              },
              "applicationAvailable": {
                "description": "Whether a user can still apply for this job.",
                "nullable": true,
                "type": "boolean"
              },
              "applyLink": {
                "description": "Direct apply link when provided by LinkedIn.",
                "nullable": true,
                "type": "string"
              },
              "basePayRange": {
                "description": "Salary range text for the position when available.",
                "nullable": true,
                "type": "string"
              },
              "baseSalary": {
                "description": "Structured base pay range when available.",
                "nullable": true,
                "properties": {
                  "currency": {
                    "description": "Payment currency symbol or code when available.",
                    "nullable": true,
                    "type": "string"
                  },
                  "maxAmount": {
                    "description": "Maximum base pay amount when available.",
                    "nullable": true,
                    "type": "number"
                  },
                  "minAmount": {
                    "description": "Minimum base pay amount when available.",
                    "nullable": true,
                    "type": "number"
                  },
                  "paymentPeriod": {
                    "description": "Pay interval for the base salary when available.",
                    "nullable": true,
                    "type": "string"
                  }
                },
                "required": [
                  "minAmount",
                  "maxAmount",
                  "currency",
                  "paymentPeriod"
                ],
                "type": "object"
              },
              "companyId": {
                "description": "Unique identifier for the hiring company when available.",
                "nullable": true,
                "type": "string"
              },
              "companyLogoUrl": {
                "description": "Company logo image URL when available.",
                "nullable": true,
                "type": "string"
              },
              "companyName": {
                "description": "Name of the hiring company.",
                "nullable": true,
                "type": "string"
              },
              "companyUrl": {
                "description": "LinkedIn profile link of the hiring company.",
                "nullable": true,
                "type": "string"
              },
              "countryCode": {
                "description": "Two-letter country code when available.",
                "nullable": true,
                "type": "string"
              },
              "descriptionFormatted": {
                "description": "Job description as formatted on LinkedIn.",
                "nullable": true,
                "type": "string"
              },
              "employmentType": {
                "description": "Type of employment offered.",
                "nullable": true,
                "type": "string"
              },
              "function": {
                "description": "Department or function of the job.",
                "nullable": true,
                "type": "string"
              },
              "id": {
                "description": "Unique identifier for the job listing when available.",
                "nullable": true,
                "type": "string"
              },
              "industries": {
                "description": "Industries associated with the job.",
                "nullable": true,
                "type": "string"
              },
              "isEasyApply": {
                "description": "Whether LinkedIn Easy Apply is available.",
                "nullable": true,
                "type": "boolean"
              },
              "jobPoster": {
                "description": "LinkedIn member who posted the job when available.",
                "nullable": true,
                "properties": {
                  "name": {
                    "description": "Job poster's display name on LinkedIn.",
                    "nullable": true,
                    "type": "string"
                  },
                  "profileUrl": {
                    "description": "Job poster's LinkedIn profile URL.",
                    "nullable": true,
                    "type": "string"
                  },
                  "title": {
                    "description": "Job poster's current role or title.",
                    "nullable": true,
                    "type": "string"
                  }
                },
                "required": [
                  "name",
                  "title",
                  "profileUrl"
                ],
                "type": "object"
              },
              "location": {
                "description": "Geographic location of the job.",
                "nullable": true,
                "type": "string"
              },
              "postedAt": {
                "description": "When the job was posted (relative or absolute label from LinkedIn).",
                "nullable": true,
                "type": "string"
              },
              "postedDate": {
                "description": "ISO-8601 posting timestamp when available.",
                "nullable": true,
                "type": "string"
              },
              "salaryStandards": {
                "description": "Employer-provided pay standards or notes.",
                "nullable": true,
                "type": "string"
              },
              "seniorityLevel": {
                "description": "Seniority level of the position.",
                "nullable": true,
                "type": "string"
              },
              "summary": {
                "description": "Brief overview of job responsibilities.",
                "nullable": true,
                "type": "string"
              },
              "title": {
                "description": "Title of the advertised job position.",
                "nullable": true,
                "type": "string"
              },
              "url": {
                "description": "Public URL for the job posting on LinkedIn.",
                "minLength": 1,
                "type": "string"
              }
            },
            "required": [
              "id",
              "url",
              "title",
              "companyName",
              "companyId",
              "companyUrl",
              "location",
              "summary",
              "seniorityLevel",
              "function",
              "employmentType",
              "industries",
              "basePayRange",
              "postedAt",
              "postedDate",
              "applicantCount",
              "jobPoster",
              "applicationAvailable",
              "descriptionFormatted",
              "baseSalary",
              "salaryStandards",
              "isEasyApply",
              "applyLink",
              "countryCode",
              "companyLogoUrl"
            ],
            "type": "object"
          },
          "type": "array"
        },
        "lookupStatus": {
          "description": "Whether the job search completed for this request.",
          "enum": [
            "found",
            "not_found"
          ],
          "type": "string"
        },
        "summary": {
          "description": "Summary counts for this search response.",
          "properties": {
            "returned": {
              "description": "Number of job listings returned in this response.",
              "minimum": 0,
              "type": "integer"
            }
          },
          "required": [
            "returned"
          ],
          "type": "object"
        }
      },
      "required": [
        "lookupStatus",
        "jobs",
        "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"
}