v1

latestOpenAPI 3.0.12026-07-24283883639.5 KB

User

Get All Experiences for a Specific User

This endpoint retrieves all experiences for a specific user. <h3>Required Scope</h3>experiences:read or experiences:write

get/api/v2/users/{id}/experiences

Path parameters

idstring required

The unique ID of the user to retrieve experiences for.

Query parameters

limitinteger

The maximum number of experiences to display per page. A maximum of 1000 is allowed.

identifierstring

Example:<email_value>?identifier=email

How to identify the user. The identifier can be id (default), employee-id, or email and must be used as a query string URL parameter.

filter[experience_type]string

Filter criteria that only returns content with this experience type. Acceptable values are JobRole, Project, Menteeship, Mentorship, Shadowing, StretchAssignment, or Other.

filter[title]string

Filter criteria that only returns content with this title.

filter[start_date]string date

Filter criteria that returns experiences from this date through filter[end_date]. Format yyyy-mm-dd.

filter[end_date]string date

Filter criteria that returns experiences from filter[start_date] through this date. Format yyyy-mm-dd.

Response

Success

Example response

{
  "data": [
    {
      "type": "experiences",
      "id": "rrKQ3m3",
      "attributes": {
        "experience-type": "JobRole",
        "weekly-hours": 40,
        "organization-name": "ABC Org",
        "title": "Developer",
        "seniority": "Intermediate",
        "points-earned": "6.2830080"
      },
      "relationships": [
        {
          "created-by": {
            "data": {
              "id": "Oy158",
              "type": "users"
            }
          }
        }
      ]
    }
  ]
}