get
https://subdomain.saplingapp.io/api/v1/beta/profiles/
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Returns the information about a user in the Sapling platform.
You can find the GUID by using the Get all Users request, or by running a report inside of Sapling.
Job Details Tables
When using a 'get' command to fetch job details when calling this end point, the full tables, with each field listed below it, will be returned. This includes all profile tables, including job details and custom tables. For example, If you are trying to pull an employee's compensation details, you will find their pay rate, pay schedule, and pay type nested in the compensation table within that user's properties.
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"users": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {"type": "integer"},
"guid": {"type": "string"},
"start_date": {"type": "string", "format": "date"},
"first_name": {"type": "string"},
"last_name": {"type": "string"},
"job_title": {"type": "string"},
"location": {"type": "string"},
"department": {"type": "string"},
"state": {"type": "string", "enum": ["active", "inactive"]},
"company_email": {"type": "string", "format": "email"},
"personal_email": {"type": "string", "format": "email"},
"compensation": {
"type": "object",
"properties": {
"effective_date": {"type": "string", "format": "date"},
"pay_rate": {
"type": "object",
"properties": {
"currency_type": {"type": "string"},
"currency_value": {"type": "string"}
},
"required": ["currency_type", "currency_value"]
},
"pay_type": {"type": "string"},
"pay_schedule": {"type": "string"},
"change_reason": {"type": "string"},
"notes": {"type": "string"}
}
}
},
"required": ["guid", "start_date", "first_name", "last_name", "job_title", "location", "department", "company_email", "personal_email"]
}
}
},
"required": ["users"]
}