Schemas

On this page, we outline schemas for Job, User, and Application objects.

Job Schema

All jobs will follow this schema, but international jobs will have some null fields.

  • Name
    id
    Type
    string
    Description

    Job identifier.

  • Name
    name
    Type
    string
    Description

    Job title.

  • Name
    snippet
    Type
    string
    Description

    Short description of the job.

  • Name
    category
    Type
    string
    Description

    Industry of the job (specific).

  • Name
    posted_time
    Type
    string
    Description

    Time the job was posted.

  • Name
    url
    Type
    string
    Description

    Url of the job.

  • Name
    location
    Type
    string
    Description

    Full location of job (city, state, country); country is almost always 'USA'.

  • Name
    city
    Type
    string
    Description

    City the job is located in.

  • Name
    state
    Type
    string
    Description

    State the job is located in. Null for international jobs.

  • Name
    country
    Type
    string
    Description

    Country the job is located in. Null for international jobs.

  • Name
    salary_source
    Type
    string
    Description

    Calculation of salary (eg: 'parsed', 'predicted'). Null for international jobs.

  • Name
    salary_interval
    Type
    string
    Description

    Interval salary is paid in (eg: 'yearly', 'monthly'). Null for international jobs.

  • Name
    salary_max
    Type
    integer
    Description

    High end of the salary prediction.

  • Name
    salary_max_annual
    Type
    integer
    Description

    High end of annual salary for non-annual salary intervals.

  • Name
    salary_min
    Type
    integer
    Description

    Low end of salary prediction.

  • Name
    salary_min_annual
    Type
    integer
    Description

    Low end of annual salary for non-annual salary intervals.

  • Name
    industry_name
    Type
    string
    Description

    Industry of the job (general). Null for international jobs.

  • Name
    hiring_company
    Type
    dictionary
    Description
    • Name
      id
      Type
      string
      Description

      Identifier of the company. Null for international jobs.

    • Name
      name
      Type
      string
      Description

      Name of the company.

    • Name
      url
      Type
      string
      Description

      Link to company homepage. Null for international jobs.

    • Name
      description
      Type
      string
      Description

      Brief description of the company. Null for international jobs.

User Schema

All users will follow this schema.

  • Name
    name
    Type
    string
    Description

    User's full name.

  • Name
    email
    Type
    string
    Description

    User's email.

  • Name
    phone
    Type
    string
    Description

    User's phone number.

  • Name
    address
    Type
    string
    Description

    Address of the user in form (address, city, state).

  • Name
    portfolio
    Type
    string
    Description

    Link to the user's portfolio website. Optional.

  • Name
    filename
    Type
    string
    Description

    Filename of the user's resume. Must be .pdf, .docx, or .txt.

  • Name
    resumeLink
    Type
    string
    Description

    Publically accessable link to the user's resume. Must be .pdf, .docx, .txt, and below 5mb.

  • Name
    keyInfo
    Type
    string
    Description

    Brief descritpion of the user's experience. No more than 400 words.

  • Name
    linkedin
    Type
    string
    Description

    Link to the user's LinkedIn profile. Optional.

  • Name
    github
    Type
    string
    Description

    Link to the user's Github profile. Optional.

  • Name
    twitter
    Type
    string
    Description

    Link to the user's Twitter profile. Optional.

  • Name
    figma
    Type
    string
    Description

    Link to the user's Figma profile. Optional.

  • Name
    dribbble
    Type
    string
    Description

    Link to the user's Dribbble profile. Optional.

  • Name
    stackoverflow
    Type
    string
    Description

    Link to the user's Stackoverflow profile. Optional.

Application Schema

All applications will follow this schema.

  • Name
    address
    Type
    string
    Description

    User's address.

  • Name
    jobId
    Type
    string
    Description

    Id of the job, returned with the job when it is fetched.

  • Name
    url
    Type
    string
    Description

    Job url returned when the job is fetched.

  • Name
    inputs
    Type
    array
    Description

    Array of input arrays in the following form:

  • Name
    label
    Type
    string
    Description

    Question to be asked.

  • Name
    selector
    Type
    string
    Description

    Internal Wrangle field.

  • Name
    tag
    Type
    string
    Description

    Tag of the field (textArea, text, input, button, etc). For internal use.

  • Name
    type
    Type
    string
    Description

    Same as tag. For internal use.

  • Name
    value
    Type
    string
    Description

    Current user or AI-provided value for the field (answer to the question).

  • Name
    options
    Type
    array
    Description

    Array of dictionaries representing each option, ('label': label, 'value': value_1). Will be null if the field doesn't require options.

  • Name
    filename
    Type
    string
    Description

    Filename of the resume of the user submitting the application.

  • Name
    coverLetter
    Type
    string
    Description

    Optional cover letter for the application.

  • Name
    profileId
    Type
    string
    Description

    Uid of the applying user.

  • Name
    companyName
    Type
    string
    Description

    Name of your company.

  • Name
    title
    Type
    string
    Description

    Title of the job to apply to.

  • Name
    inputValues
    Type
    string
    Description

    Dictionary mapping labels to answers. This is where answers to questions live until apply is called, where these answers are moved into inputs.

Was this page helpful?