Retrieve User Profiles

The ability to retrieve individual and bulk profiles is a useful part of Wrangle's services.

Return Schema

The profile model contains detailed information about the necessary aspects of a complete profile, such as full name, email, phone number, etc.

Properties

  • Name
    credentials
    Type
    object
    Description
    • Name
      email
      Type
      string
      Description

      User's email address.

    • Name
      password
      Type
      string
      Description

      User's password (unhashed—will be hashed in account creation).

  • Name
    information
    Type
    object
    Description
    • Name
      first_name
      Type
      string
      Description

      User's first name.

    • Name
      last_name
      Type
      string
      Description

      User's last name.

    • Name
      address
      Type
      string
      Description

      User's address.

    • Name
      city
      Type
      string
      Description

      User's city.

    • Name
      state
      Type
      string
      Description

      User's state.

    • Name
      postal_code
      Type
      string
      Description

      User's postal code.

    • Name
      phone_number
      Type
      string
      Description

      User's phone number.

  • Name
    experience
    Type
    object
    Description
  • Name
    work_experience
    Type
    array
    Description

    Array of user's work experience objects.

  • Name
    experience example
    Type
    object
    Description
  • Name
    job_title
    Type
    string
    Description

    Title of the job.

  • Name
    company
    Type
    string
    Description

    Company name.

  • Name
    location
    Type
    string
    Description

    Location of the job.

  • Name
    current_job
    Type
    string
    Description

    Whether or not this job is the user's current job. "true" or "false".

  • Name
    start_date
    Type
    string
    Description

    Start date of the job.

  • Name
    end_date
    Type
    string
    Description

    End date of the job. Optional.

  • Name
    description
    Type
    string
    Description

    Description of the job.

  • Name
    school
    Type
    array
    Description

    Array of user's school experience details.

  • Name
    school example
    Type
    object
    Description
  • Name
    school
    Type
    string
    Description

    Name of the school.

  • Name
    degree
    Type
    string
    Description

    Degree recieved. Options: "GED", "High School", "Associates", "Bachelors", "Masters", "Doctorate", "No Education".

  • Name
    field
    Type
    string
    Description

    Field of study.

  • Name
    linkedIn
    Type
    string
    Description

    LinkedIn profile link.

  • Name
    filename
    Type
    string
    Description

    Filename of the user's resume.

  • Name
    resumeLink
    Type
    string
    Description

    Public link to the user's resume.

  • Name
    disclosures
    Type
    object
    Description
    • Name
      race
      Type
      string
      Description

      User's race/ethnicity. Options: 'American Indian or Alaska Native (Not Hispanic or Latino) (USA)', 'Black or African American (Not Hispanic or Latino) (USA)', 'Chose Not to Disclose (USA)', 'Hispanic or Latino (USA)', 'Native Hawaiian or Other Pacific Islander (Not Hispanic or Latino) (USA)', 'Two or More Races (Not Hispanic or Latino) (USA)', 'White (Not Hispanic or Latino) (USA)'.

    • Name
      hispanic_or_latino
      Type
      boolean
      Description

      Indicates if the user identifies as Hispanic or Latino.

    • Name
      gender
      Type
      string
      Description

      User's gender. Options: 'Female', 'Male', 'Not Disclosed'.

    • Name
      veteran_status
      Type
      string
      Description

      User's veteran status. Options: 'I IDENTIFY AS ONE OR MORE OF THE CLASSIFICATIONS OF PROTECTED VETERANS LISTED ABOVE', 'I IDENTIFY AS A VETERAN, JUST NOT A PROTECTED VETERAN', 'I AM NOT A VETERAN', 'I DO NOT WISH TO SELF-IDENTIFY'.

  • Name
    uid
    Type
    string
    Description

    Unique identifier for the user.


POST/api-retrieve-all-profiles

Retrieve all profiles

This endpoint allows you to retrieve all user profiles for your company. There is no need for any input parameters for this call.

We generally only recommend using this endpoint if you need to compile analytics on users, otherwise it's more optimal to use api-view-user-profile.

Response

{
  "profiles": [
    {
      // ...
    },
    {
      //...
    }
  ]
}

POST/api-view-user-profile

Retrieve One Profile

This endpoint allows you to retrieve individual user profiles for your company. There is one input: uid.

Request

POST
/api/api-view-user-profile
curl -X POST https://app.wranglejobs.com/api/api-view-user-profile \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {api-key}' \
  -d '{"uid": "user_uid"}'

Was this page helpful?