Use the users API endpoint with the GET method to retrieve a specific user’s details by user ID or username.
Prerequisites
Note the username or user ID of the user whose details you want to retrieve.
Base URL
https://api.prontoforms.com
Endpoints
GET
/api/1.1/users/{userID}
Retrieves the details of a specific user by user ID.
/api/1.1/users/username/{username}
Retrieves the details of a specific user by username.
URL structures
Copy
https://api.prontoforms.com/api/1.1/users/{userID}Copy
https://api.prontoforms.com/api/1.1/users/username/{username}Request parameters
| Parameter | Required? | Default value | Description |
|---|---|---|---|
tz | no | UTC | Specify the timezone for the user’s last log in date. Info:The external resource List of tz database time zones contains a full list of supported time zones in the column TZ database name. |
Request header
Include the standard authorization header. This includes the username and password, where username is the API Key ID and password is the API Key Secret.
cURL examples
curl -v -k -u {username}:{password} -X GET https://api.prontoforms.com/api/1.1/users/{userID}curl -v -k -u {username}:{password} -X GET https://api.prontoforms.com/api/1.1/users/username/{username}where username is the API Key ID and password is the API Key Secret.
Request body
None
Response code
200—OK
Response example
Copy
{
"identifier": "130000000",
"username": "user.admin",
"role": "ProntoAdmin",
"email": "useradmin@email.com",
"alternateEmail": null,
"firstName": "Jane",
"lastName": "Doe",
"companyName": "Company Co.",
"address": null,
"locale": "en",
"preferredTimeZone": "America/Detroit",
"phoneNumber": "+16131111111",
"billingId": "2500000000",
"defaultViewFormSpaceId": "190000000",
"defaultViewFormDashboardId": null,
"groupIds": [
"2100000000",
"2100000001"
],
"lastLoginDate": "2020-11-20T17:56:39Z",
"organization": {
"employeeId": null,
"managerName": null,
"managerEmailAddress": null,
"managerPhoneNumber": null,
"company": null,
"department": null,
"division": null,
"organizationalUnitName": null,
"organizationalUnitAddress": null,
"region": null,
"subRegion": null,
"branch": null,
"branchOffice": null,
"office": null
}
}Error codes
| Error code | Error message | HTTP response code | Description |
|---|---|---|---|
| AccessDenied | Access Denied: You are not allowed to access the requested resource. | 403 | The user doesn't exist in your team. |
| ObjectNotFound | Object Not Found: The object you requested could not be found | 404 | The system couldn't find the user. Enter an existing username or user ID. |
Comments
0 comments
Please sign in to leave a comment.