/experiences

Returns a single or multiple self-reported experience records, sorted by Experience ID.

Optional Parameters:

Parameter

Description

Type

page

The specific page number in a paginated list of results 

Including this parameter in your call will limit the response to a single page matching the page sequence order represented by the page number.

INT

pageSize

The number of items to include in the page of results 

Including this parameter in your call will adjust the response to only include no more than the number of items that you specify on each page.

Note: The value “100” will be used by default if the parameter is not explicitly set and the maximum value is “500”.

INT

experienceTypeId

The ID of the specific experience type an experience must have in order to be included in the response 

INT

status

The status that experiences must have in order to be included in the response 

Including this parameter in your call will limit the response to only include experiences with the status value specified.

Note: Accepted values include “approved”, “pending”, or “all”. The value “all” will be used by default if the parameter is not explicitly set.

STRING

userId

The user ID of the specific user whose experiences will be returned in the response 

STRING

username

The username of the user that experiences must have been created by in order to be included in the response 

STRING

startDate

A date filter based on the start date of a roster membership 

Including this parameter in your call will limit the response to only include roster members with positions held on or after the specified date.

Note: dates must be represented in milliseconds/UTC time (e.g., November 12, 2013 is 1384232400000 milliseconds since 1/1/1970 00:00:00 which is the start of Unix Epoch Time)

LONG

endDate

A date filter based on the end date of a roster membership 

Including this parameter in your call will limit the response to only include roster members with positions held on or before the specified date.

Note: dates must be represented in milliseconds/UTC time (e.g., November 12, 2013 is 1384232400000 milliseconds since 1/1/1970 00:00:00 which is the start of Unix Epoch Time)

LONG


Example: Calling for all experiences in the system

Sample Call:

https://yoursite/api/experiences

Sample Response:

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Need More Help?

Additional Support

Powered by Zendesk