Help Desk

Submit a ticket My Tickets
Welcome
Login

Namely Command Reference

Commands using the Namely REST API

Connections

Namely

Connection to the Namely API

Inputs

Input Type Detail Notes
Personal access token TextField Namely personal access token. See https://developers.namely.com/1.0/authentication/authentication for details on how to generate a personal access token.
Subdomain TextField The subdomain of your Namely organization

Commands

Find Profiles

Searches for user profiles given filtering criteria

Inputs

Input Type Detail Notes
Email filter TextField Filter find results by a profile's email address
Personal email filter TextField Filter find results by a profile's personal email address
First name filter TextField Filter find results by a profile's first name
Last name filter TextField Filter find results by a profile's last name
Job title filter TextField Filter find results by a profile's job title
Reports to filter TextField ID of the profile that the user(s) report to
User status filter DropdownField Filter find results by a user's status
Sort order DropdownField The field by which the search results will be sorted

Outputs

Output Output Type Notes
Found profiles JSON Json
Number of profiles found Integer

Exit Codes

Code Type Detail
0 Success The task completed successfully
1 Error General failure
2 Error Invalid arguments

Get Report

Downloads a report created in Namely given a report ID

Inputs

Input Type Detail Notes
Report ID TextField Namely report ID

Outputs

Output Output Type Notes
Namely report file File

Exit Codes

Code Type Detail
0 Success The command completed successfully
1 Error Task failed
2 Error Invalid arguments
B
Brian is the author of this solution article.

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.