{"id":2599,"date":"2024-07-05T18:42:51","date_gmt":"2024-07-05T18:42:51","guid":{"rendered":"\/agile\/?post_type=ht_kb&#038;p=2599"},"modified":"2024-08-13T20:53:44","modified_gmt":"2024-08-13T20:53:44","slug":"introduction-to-customer-apis","status":"publish","type":"ht_kb","link":"\/agile\/knowledge-base\/introduction-to-customer-apis\/","title":{"rendered":"Introduction to Customer APIs"},"content":{"rendered":"\n<p>Customer APIs are built to provide flexibility to our users to get information or post data from\/to the database. It allows external entities (like customers, partners, or connector products) to call a Synerion Agile API to get or post data.<\/p>\n\n\n\n<p><strong>The API can be used for the following major use cases:<\/strong><\/p>\n\n\n\n<ol class=\"wp-block-list\">\n<li>Get employee\u2019s basic and extended profile information, such as, employee\u2019s personal details, job costing, work rule, absences, schedule, and benefit package. Other extended information includes hire date, probation date, home &amp; corporate address details, public, corporate &amp; <a id=\"post-2599-_Int_LHYx1aki\"><\/a>private information.<\/li>\n\n\n\n<li>Get information on employee\u2019s work time and labor costing data.<\/li>\n\n\n\n<li>Retrieve information on punches such as original punch type, time &amp; date, jobs &amp; departments, and any modified punches with details on punch time, date &amp; punch type.<\/li>\n\n\n\n<li>Customer API can also be used to submit the employee time and attendance and costing punches.<\/li>\n<\/ol>\n\n\n\n<p><\/p>\n\n\n\n<p class=\"has-vivid-cyan-blue-color has-text-color has-large-font-size\">Collection of API&#8217;s<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>API authentication<\/li>\n\n\n\n<li>Daily time transactions and costing time transactions<\/li>\n\n\n\n<li>Employee profiles and employee profiles extended<\/li>\n\n\n\n<li>Get punches<\/li>\n\n\n\n<li>Grosvenor \u2013 punch and employees<\/li>\n<\/ul>\n\n\n\n<p><strong>API documentation link: <\/strong><a href=\"https:\/\/api-swagger.synerionagile.com\/\">https:\/\/api-swagger.synerionagile.com\/<\/a><\/p>\n\n\n\n<p><strong>Base\/Parent url<\/strong>: <a href=\"https:\/\/api.synerionagile.com\/\">https:\/\/api.synerionagile.com\/<\/a><\/p>\n\n\n\n<p><\/p>\n\n\n\n<p class=\"has-text-color has-medium-font-size\" style=\"color:#0303ab\"><strong>API Authentication<\/strong><\/p>\n\n\n\n<p>Synerion API uses Bearer authentication (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. The name \u201cBearer authentication\u201d can be understood as \u201cgive access to the bearer of this token.\u201d The bearer token is a cryptic string, usually generated by the server in response to a login request. The client must send this token in the Authorization header when making requests to protected resources.<\/p>\n\n\n\n<p>An API service user is created to use for authentication purposes. This user is authorized to have visibility to all departments and employees.<\/p>\n\n\n\n<p><strong>Endpoint: <\/strong><\/p>\n\n\n\n<figure class=\"wp-block-image size-full\"><img loading=\"lazy\" decoding=\"async\" width=\"1374\" height=\"216\" src=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-50.png\" alt=\"\" class=\"wp-image-3219\" srcset=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-50.png 1374w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-50-300x47.png 300w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-50-1024x161.png 1024w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-50-768x121.png 768w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-50-50x8.png 50w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-50-60x9.png 60w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-50-100x16.png 100w\" sizes=\"auto, (max-width: 1374px) 100vw, 1374px\" \/><\/figure>\n\n\n\n<p><strong>Description: <\/strong><\/p>\n\n\n\n<p>This API is used to authenticate the API service user and generates the JWT token. This generated token is valid for 60 minutes. Once expired, the user must re-authenticate by making another call to the authentication endpoint to obtain a fresh token. This ensures secure access to the APIs and prevents unauthorized access through expired tokens.<\/p>\n\n\n\n<p><strong>Request Parameters<\/strong>:<\/p>\n\n\n\n<figure class=\"wp-block-table is-style-stripes\"><table class=\"has-fixed-layout\"><tbody><tr><td><strong>Parameter name<\/strong><\/td><td><strong>Type, mandatory\/optional, header\/Query Params<\/strong><\/td><td><strong>Description<\/strong><\/td><\/tr><tr><td><strong>AppRegion<\/strong><\/td><td>string, required, header<\/td><td>Use \u2018CAE\u2019 for Canada<br>Use \u2018USE2\u2019 for United States<\/td><\/tr><tr><td><strong>Content-Type<\/strong><\/td><td>String, required, header<\/td><td>Use application\/json<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<p><strong>Request Body<\/strong>:<\/p>\n\n\n\n<figure class=\"wp-block-image size-large\"><img loading=\"lazy\" decoding=\"async\" width=\"1024\" height=\"378\" src=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-51-1024x378.png\" alt=\"\" class=\"wp-image-3221\" srcset=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-51-1024x378.png 1024w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-51-300x111.png 300w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-51-768x284.png 768w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-51-50x18.png 50w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-51-1536x567.png 1536w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-51-60x22.png 60w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-51-100x37.png 100w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-51.png 1684w\" sizes=\"auto, (max-width: 1024px) 100vw, 1024px\" \/><\/figure>\n\n\n\n<p class=\"has-background\" style=\"background-color:#fbeb36\"><strong>NOTE: Credentials and API key, required for accessing the APIs, will be provided by Synerion<\/strong><\/p>\n\n\n\n<p><strong>Response:<\/strong><\/p>\n\n\n\n<figure class=\"wp-block-image size-full\"><img loading=\"lazy\" decoding=\"async\" width=\"1474\" height=\"50\" src=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-52.png\" alt=\"\" class=\"wp-image-3223\" srcset=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-52.png 1474w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-52-300x10.png 300w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-52-1024x35.png 1024w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-52-768x26.png 768w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-52-50x2.png 50w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-52-60x2.png 60w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-52-100x3.png 100w\" sizes=\"auto, (max-width: 1474px) 100vw, 1474px\" \/><\/figure>\n\n\n\n<p><strong>Response Codes:<\/strong><\/p>\n\n\n\n<figure class=\"wp-block-image size-full\"><img loading=\"lazy\" decoding=\"async\" width=\"1828\" height=\"244\" src=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-53.png\" alt=\"\" class=\"wp-image-3225\" srcset=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-53.png 1828w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-53-300x40.png 300w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-53-1024x137.png 1024w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-53-768x103.png 768w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-53-50x7.png 50w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-53-1536x205.png 1536w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-53-60x8.png 60w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-53-100x13.png 100w\" sizes=\"auto, (max-width: 1828px) 100vw, 1828px\" \/><\/figure>\n\n\n\n<h1 class=\"has-vivid-cyan-blue-color has-text-color has-large-font-size wp-block-heading\">Postman Example(s)<\/h1>\n\n\n\n<p class=\"has-text-color has-medium-font-size\" style=\"color:#0303ab\"><strong>Authentication<\/strong><\/p>\n\n\n\n<p>1. <strong>POST <\/strong><a href=\"https:\/\/api.synerionagile.com\/v1\/Authentication\/Login\">https:\/\/api.synerionagile.com\/v1\/Authentication\/Login<\/a><\/p>\n\n\n\n<p>2. Add a Request Header<\/p>\n\n\n\n<p>      AppRegion &#8211;&gt; CAE or USE2<\/p>\n\n\n\n<figure class=\"wp-block-image\"><img loading=\"lazy\" decoding=\"async\" width=\"1462\" height=\"484\" src=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/07\/a-screenshot-of-a-computer-description-automatica.png\" alt=\"A screenshot of a computer\n\nDescription automatically generated\" class=\"wp-image-2600\" srcset=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/07\/a-screenshot-of-a-computer-description-automatica.png 1462w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/07\/a-screenshot-of-a-computer-description-automatica-300x99.png 300w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/07\/a-screenshot-of-a-computer-description-automatica-1024x339.png 1024w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/07\/a-screenshot-of-a-computer-description-automatica-768x254.png 768w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/07\/a-screenshot-of-a-computer-description-automatica-50x17.png 50w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/07\/a-screenshot-of-a-computer-description-automatica-60x20.png 60w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/07\/a-screenshot-of-a-computer-description-automatica-100x33.png 100w\" sizes=\"auto, (max-width: 1462px) 100vw, 1462px\" \/><\/figure>\n\n\n\n<p>3. Add a Request Body<\/p>\n\n\n\n<figure class=\"wp-block-image size-full is-resized\"><img loading=\"lazy\" decoding=\"async\" src=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-54.png\" alt=\"\" class=\"wp-image-3227\" width=\"278\" height=\"127\" srcset=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-54.png 620w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-54-300x136.png 300w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-54-50x23.png 50w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-54-60x27.png 60w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-54-100x45.png 100w\" sizes=\"auto, (max-width: 278px) 100vw, 278px\" \/><\/figure>\n\n\n\n<figure class=\"wp-block-image\"><img loading=\"lazy\" decoding=\"async\" width=\"1108\" height=\"495\" src=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/07\/a-screenshot-of-a-computer-description-automatica-1.png\" alt=\"A screenshot of a computer\n\nDescription automatically generated\" class=\"wp-image-2602\" srcset=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/07\/a-screenshot-of-a-computer-description-automatica-1.png 1108w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/07\/a-screenshot-of-a-computer-description-automatica-1-300x134.png 300w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/07\/a-screenshot-of-a-computer-description-automatica-1-1024x457.png 1024w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/07\/a-screenshot-of-a-computer-description-automatica-1-768x343.png 768w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/07\/a-screenshot-of-a-computer-description-automatica-1-50x22.png 50w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/07\/a-screenshot-of-a-computer-description-automatica-1-60x27.png 60w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/07\/a-screenshot-of-a-computer-description-automatica-1-100x45.png 100w\" sizes=\"auto, (max-width: 1108px) 100vw, 1108px\" \/><\/figure>\n\n\n\n<p>4. [<strong>Optionally<\/strong>] store the bearer token for subsequent calls<\/p>\n\n\n\n<p>Add this script in the Scripts tab to store token in the \u201cbearer_token\u201d environment variable. You may need to create this environment variable first.<\/p>\n\n\n\n<figure class=\"wp-block-image size-large\"><img loading=\"lazy\" decoding=\"async\" width=\"1024\" height=\"234\" src=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-55-1024x234.png\" alt=\"\" class=\"wp-image-3229\" srcset=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-55-1024x234.png 1024w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-55-300x69.png 300w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-55-768x176.png 768w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-55-50x11.png 50w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-55-60x14.png 60w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-55-100x23.png 100w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-55.png 1346w\" sizes=\"auto, (max-width: 1024px) 100vw, 1024px\" \/><\/figure>\n\n\n\n<figure class=\"wp-block-image\"><img loading=\"lazy\" decoding=\"async\" width=\"1121\" height=\"452\" src=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/07\/a-screenshot-of-a-computer-description-automatica-2.png\" alt=\"A screenshot of a computer\n\nDescription automatically generated\" class=\"wp-image-2604\" srcset=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/07\/a-screenshot-of-a-computer-description-automatica-2.png 1121w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/07\/a-screenshot-of-a-computer-description-automatica-2-300x121.png 300w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/07\/a-screenshot-of-a-computer-description-automatica-2-1024x413.png 1024w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/07\/a-screenshot-of-a-computer-description-automatica-2-768x310.png 768w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/07\/a-screenshot-of-a-computer-description-automatica-2-50x20.png 50w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/07\/a-screenshot-of-a-computer-description-automatica-2-60x24.png 60w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/07\/a-screenshot-of-a-computer-description-automatica-2-100x40.png 100w\" sizes=\"auto, (max-width: 1121px) 100vw, 1121px\" \/><\/figure>\n\n\n\n<p class=\"has-text-color has-medium-font-size\" style=\"color:#0303ab\"><strong>Get Employees basic<\/strong><\/p>\n\n\n\n<div class=\"wp-block-group is-vertical is-layout-flex wp-container-core-group-is-layout-8cf370e7 wp-block-group-is-layout-flex\">\n<ol class=\"wp-block-list\">\n<li><strong>GET <\/strong><a href=\"https:\/\/api.synerionagile.com\/v1\/Employee\/EmployeeProfiles\">https:\/\/api.synerionagile.com\/v1\/Employee\/EmployeeProfiles<\/a><\/li>\n\n\n\n<li>In the <strong>Headers<\/strong> tab\n<ul class=\"wp-block-list\">\n<li>Add a Request Header: \n<ul class=\"wp-block-list\">\n<li>AppRegion &#8211;&gt; CAE or USE2<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<\/li>\n\n\n\n<li>In the <strong>Authorization<\/strong> tab\n<ol class=\"wp-block-list\">\n<li>Set Auth Type &#8211;&gt; Bearer Token<\/li>\n\n\n\n<li>Use the {{bearer_token}} environment variable if used step 4 Or Manually copy the authentication token in the text box<\/li>\n<\/ol>\n<\/li>\n<\/ol>\n<\/div>\n\n\n\n<figure class=\"wp-block-image\"><img loading=\"lazy\" decoding=\"async\" width=\"952\" height=\"526\" src=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/07\/a-screenshot-of-a-computer-description-automatica-3.png\" alt=\"A screenshot of a computer\n\nDescription automatically generated\" class=\"wp-image-2606\" srcset=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/07\/a-screenshot-of-a-computer-description-automatica-3.png 952w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/07\/a-screenshot-of-a-computer-description-automatica-3-300x166.png 300w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/07\/a-screenshot-of-a-computer-description-automatica-3-768x424.png 768w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/07\/a-screenshot-of-a-computer-description-automatica-3-50x28.png 50w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/07\/a-screenshot-of-a-computer-description-automatica-3-60x33.png 60w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/07\/a-screenshot-of-a-computer-description-automatica-3-100x55.png 100w\" sizes=\"auto, (max-width: 952px) 100vw, 952px\" \/><\/figure>\n\n\n\n<p><strong>Note:<\/strong> The authentication token and AppRegion header <strong>MUST <\/strong>be included with <strong>ALL<\/strong> API calls.<\/p>\n\n\n\n<p><strong>Tip:<\/strong> It\u2019s best to generate a new auth token before making an API call to avoid expiration issues.<\/p>\n\n\n\n<p class=\"has-vivid-cyan-blue-color has-text-color has-large-font-size\">Employee Profiles<\/p>\n\n\n\n<p>Employee Profiles endpoints are used to extract the employee profile information. Employee profile has two below endpoints:<\/p>\n\n\n\n<figure class=\"wp-block-image size-large\"><img loading=\"lazy\" decoding=\"async\" width=\"1024\" height=\"82\" src=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-56-1024x82.png\" alt=\"\" class=\"wp-image-3231\" srcset=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-56-1024x82.png 1024w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-56-300x24.png 300w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-56-768x62.png 768w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-56-50x4.png 50w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-56-60x5.png 60w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-56-100x8.png 100w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-56.png 1192w\" sizes=\"auto, (max-width: 1024px) 100vw, 1024px\" \/><\/figure>\n\n\n\n<p><strong>Note:<\/strong> These endpoints respect the department and employee visibility. The API service user has full visibility to all departments that existed at the time of the service user registration. For any newly created departments, you may need to contact the support team to adjust the service user\u2019s department visibility.<\/p>\n\n\n\n<p class=\"has-text-color has-medium-font-size\" style=\"color:#0303ab\"><strong>Basic info<\/strong><\/p>\n\n\n\n<p><strong>Endpoint:<\/strong><\/p>\n\n\n\n<figure class=\"wp-block-image size-large\"><img loading=\"lazy\" decoding=\"async\" width=\"1024\" height=\"117\" src=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-57-1024x117.png\" alt=\"\" class=\"wp-image-3234\" srcset=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-57-1024x117.png 1024w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-57-300x34.png 300w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-57-768x88.png 768w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-57-50x6.png 50w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-57-60x7.png 60w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-57-100x11.png 100w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-57.png 1046w\" sizes=\"auto, (max-width: 1024px) 100vw, 1024px\" \/><\/figure>\n\n\n\n<p><strong>Description: <\/strong><\/p>\n\n\n\n<p>This endpoint gets a list of employee profile information. This list is paginated. This API returns the basic information of an employee (as mentioned in below response)<\/p>\n\n\n\n<p><strong>Required Permissions<\/strong>:<\/p>\n\n\n\n<p>Base permission: FeatureEmployee Export<\/p>\n\n\n\n<p><strong>Additional Field Level Permissions <\/strong><a id=\"post-2599-_Int_O0StD17L\"><\/a><strong>And System Settings:<\/strong><\/p>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td><strong>Permissions<\/strong><\/td><td><strong>Description<\/strong><\/td><\/tr><tr><td><em>Base_permission <\/em><strong>&amp;<\/strong> <em>FeatureEmployee Profile General <\/em><\/td><td>It returns employee\u2019s info including Name, employee code, payroll code, department name &amp; number, and hire date<\/td><\/tr><tr><td><em>Base_permission<\/em> <strong>&amp;<br><\/strong> <em>FeatureJob Costing function<\/em> <strong>&amp;<\/strong><br>system setting: <em>Limit by NumberOfCargoValue<\/em><\/td><td>It returns all jobs and job values<\/td><\/tr><tr><td><em>Base_permission<\/em> <strong>&amp;<br><\/strong><em>JoinEmployeeBadge-View<\/em><\/td><td>It returns the current badge<\/td><\/tr><tr><td><em>Base_permission<\/em> <strong>&amp;<br><\/strong><em>FeatureEmployee Profile Work Rule<\/em><\/td><td>It returns the default absence, holiday schedule, current work rule, current period selection, and benefit package<\/td><\/tr><tr><td><em>Base_permission<\/em> <strong>&amp;<br><\/strong><em>FeatureEmployee Profile Rates<\/em><\/td><td>It returns the current rate, rate start date, job title and job description<\/td><\/tr><tr><td><em>Base_permission<\/em> <strong>&amp;<br><\/strong><em>FeatureEmployee Profile HR Profile<\/em><\/td><td>It returns the active status, part-time, export to payroll, and effective start date<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<p><strong>Request Parameters<\/strong>:<\/p>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td><strong>Parameter name<\/strong><\/td><td><strong>Type, mandatory\/optional, header\/Query Params<\/strong><\/td><td><strong>Description<\/strong><\/td><\/tr><tr><td><strong>AppRegion<\/strong><\/td><td>string, required, header<\/td><td>Use \u2018CAE\u2019 for Canada<br>Use \u2018USE2\u2019 for United States<\/td><\/tr><tr><td><strong>Authorization<\/strong><\/td><td>string, required, header<\/td><td>The authorization token, returned by <strong>\/v1\/authentication\/login,<\/strong> required to send this bearer token to the request<\/td><\/tr><tr><td><strong>EmployeeCodes<\/strong><\/td><td>String, optional, query params<\/td><td>Filter the punches by employee code(s)<\/td><\/tr><tr><td><strong>DepartmentNumbers<\/strong><\/td><td>String, optional, query params<\/td><td>Filter the punches by department number(s)<\/td><\/tr><tr><td><strong>Page<\/strong><\/td><td>String, optional, query params<\/td><td>The current page to get the paginated list<\/td><\/tr><tr><td><strong>PerPage<\/strong><\/td><td>String, optional, query params<\/td><td>The number of records to display per page<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<p><strong>Response:<\/strong><\/p>\n\n\n\n<figure class=\"wp-block-image size-full\"><img loading=\"lazy\" decoding=\"async\" width=\"938\" height=\"946\" src=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-58.png\" alt=\"\" class=\"wp-image-3237\" srcset=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-58.png 938w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-58-297x300.png 297w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-58-150x150.png 150w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-58-768x775.png 768w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-58-50x50.png 50w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-58-60x60.png 60w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-58-100x100.png 100w\" sizes=\"auto, (max-width: 938px) 100vw, 938px\" \/><\/figure>\n\n\n\n<p><strong>Response Codes:<\/strong><\/p>\n\n\n\n<figure class=\"wp-block-image size-large\"><img loading=\"lazy\" decoding=\"async\" width=\"1024\" height=\"152\" src=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-59-1024x152.png\" alt=\"\" class=\"wp-image-3239\" srcset=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-59-1024x152.png 1024w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-59-300x45.png 300w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-59-768x114.png 768w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-59-50x7.png 50w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-59-1536x228.png 1536w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-59-60x9.png 60w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-59-100x15.png 100w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-59.png 1564w\" sizes=\"auto, (max-width: 1024px) 100vw, 1024px\" \/><\/figure>\n\n\n\n<p class=\"has-text-color has-medium-font-size\" style=\"color:#0303ab\"><strong>Employee Profiles Extended<\/strong><\/p>\n\n\n\n<p><strong>Endpoint:<\/strong><\/p>\n\n\n\n<figure class=\"wp-block-image size-large\"><img loading=\"lazy\" decoding=\"async\" width=\"1024\" height=\"103\" src=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-60-1024x103.png\" alt=\"\" class=\"wp-image-3241\" srcset=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-60-1024x103.png 1024w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-60-300x30.png 300w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-60-768x78.png 768w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-60-50x5.png 50w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-60-1536x155.png 1536w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-60-60x6.png 60w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-60-100x10.png 100w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-60.png 1584w\" sizes=\"auto, (max-width: 1024px) 100vw, 1024px\" \/><\/figure>\n\n\n\n<p><strong>Description: <\/strong><\/p>\n\n\n\n<p>This endpoint provides a list of employee profiles with extended information, for example, end of probation, hire date, termination date, review dates, gender, marital status, number of dependencies and authorizations, and personal and corporate information.<\/p>\n\n\n\n<p><strong>Request Parameters<\/strong>:<\/p>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td><strong>Parameter name<\/strong><\/td><td><strong>Type, mandatory\/optional, header\/Query Params<\/strong><\/td><td><strong>Description<\/strong><\/td><\/tr><tr><td><strong>AppRegion<\/strong><\/td><td>string, required, header<\/td><td>Use \u2018CAE\u2019 for Canada<br>Use \u2018USE2\u2019 for United States<\/td><\/tr><tr><td><strong>Authorization<\/strong><\/td><td>string, required, header<\/td><td>The authorization token, returned by <strong>\/v1\/authentication\/login,<\/strong> required to send this bearer token to the request<\/td><\/tr><tr><td><strong>EmployeeCodes<\/strong><\/td><td>String, optional, query params<\/td><td>Filter the punches by employee code(s)<\/td><\/tr><tr><td><strong>DepartmentNumbers<\/strong><\/td><td>String, optional, query params<\/td><td>Filter the punches by department number(s)<\/td><\/tr><tr><td><strong>Page<\/strong><\/td><td>String, optional, query params<\/td><td>The current page to get the paginated list<\/td><\/tr><tr><td><strong>PerPage<\/strong><\/td><td>String, optional, query params<\/td><td>The number of records to display per page<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<p><strong>Response:<\/strong><\/p>\n\n\n\n<figure class=\"wp-block-image size-full\"><img loading=\"lazy\" decoding=\"async\" width=\"1252\" height=\"2804\" src=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/Api-1.png\" alt=\"\" class=\"wp-image-3245\" srcset=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/Api-1.png 1252w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/Api-1-134x300.png 134w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/Api-1-457x1024.png 457w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/Api-1-768x1720.png 768w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/Api-1-22x50.png 22w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/Api-1-686x1536.png 686w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/Api-1-914x2048.png 914w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/Api-1-27x60.png 27w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/Api-1-45x100.png 45w\" sizes=\"auto, (max-width: 1252px) 100vw, 1252px\" \/><\/figure>\n\n\n\n<p><strong>Response Codes:<\/strong><\/p>\n\n\n\n<figure class=\"wp-block-image size-large\"><img loading=\"lazy\" decoding=\"async\" width=\"1024\" height=\"179\" src=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-61-1024x179.png\" alt=\"\" class=\"wp-image-3247\" srcset=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-61-1024x179.png 1024w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-61-300x53.png 300w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-61-768x135.png 768w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-61-50x9.png 50w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-61-60x11.png 60w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-61-100x18.png 100w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-61.png 1256w\" sizes=\"auto, (max-width: 1024px) 100vw, 1024px\" \/><\/figure>\n\n\n\n<p class=\"has-vivid-cyan-blue-color has-text-color has-large-font-size\">Daily Transaction APIs<\/p>\n\n\n\n<p>Daily transaction APIs are useful endpoints to retrieve the employee\u2019s job information such as schedule info, punch-in &amp; out, jobs, durations, rates, costing transactions, absence and memos. The API will also exclude blank days (e.g., weekends).<\/p>\n\n\n\n<p>Daily transaction has below 2 endpoints:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>\/v1\/Daily\/TimeTransactions<\/li>\n\n\n\n<li>\/v1\/Daily\/CostingTimeTransactions<\/li>\n<\/ul>\n\n\n\n<p><\/p>\n\n\n\n<p class=\"has-text-color has-medium-font-size\" style=\"color:#0303ab\"><strong>Daily Time Transaction<\/strong><\/p>\n\n\n\n<p><strong>Endpoint:<\/strong><\/p>\n\n\n\n<figure class=\"wp-block-image size-full\"><img loading=\"lazy\" decoding=\"async\" width=\"970\" height=\"106\" src=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-62.png\" alt=\"\" class=\"wp-image-3249\" srcset=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-62.png 970w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-62-300x33.png 300w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-62-768x84.png 768w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-62-50x5.png 50w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-62-60x7.png 60w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-62-100x11.png 100w\" sizes=\"auto, (max-width: 970px) 100vw, 970px\" \/><\/figure>\n\n\n\n<p><strong>Description:<\/strong><\/p>\n\n\n\n<p>This endpoint provides a daily breakdown of employee\u2019s shift information along with hours breakdown by time category.<\/p>\n\n\n\n<p><strong>Grouping:<br><\/strong> The transactions are grouped by<\/p>\n\n\n\n<ol class=\"wp-block-list\">\n<li>Shiftmatch date<\/li>\n\n\n\n<li>Time category<\/li>\n<\/ol>\n\n\n\n<p><strong>Request Parameters<\/strong>:<\/p>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td><strong>Parameter name<\/strong><\/td><td><strong>Type, mandatory\/optional, header\/Query Params<\/strong><\/td><td><strong>Description<\/strong><\/td><\/tr><tr><td><strong>AppRegion<\/strong><\/td><td>string, required, header<\/td><td>Use \u2018CAE\u2019 for Canada<br>Use \u2018USE2\u2019 for United States<\/td><\/tr><tr><td><strong>Authorization<\/strong><\/td><td>string, required, header<\/td><td>The authorization token, returned by <strong>\/v1\/authentication\/login,<\/strong> required to send this bearer token to the request<\/td><\/tr><tr><td><strong>StartDate<\/strong><\/td><td>String(date-time), optional, query params<\/td><td>The current date will be used if omitted.<br>(date format example: 2024-03-01)<\/td><\/tr><tr><td><strong>EndDate<\/strong><\/td><td>String(date-time), optional, query params<\/td><td>The current date will be used if omitted.<br>(date format example: 2024-03-01)<\/td><\/tr><tr><td><strong>EmployeeCodes<\/strong><\/td><td>String, optional, query params<\/td><td>Filter the punches by employee code(s)<\/td><\/tr><tr><td><strong>TcgFr<\/strong><\/td><td>String, optional, query params<\/td><td>The time category group in French to search on<\/td><\/tr><tr><td><strong>TcgEn<\/strong><\/td><td>String, optional, query params<\/td><td>The time category group in English to search on<\/td><\/tr><tr><td><strong>TcgSp<\/strong><\/td><td>String, optional, query params<\/td><td>The time category group in Spanish to search on<\/td><\/tr><tr><td><strong>DepartmentNumbers<\/strong><\/td><td>String, optional, query params<\/td><td>Filter the punches by department number(s)<\/td><\/tr><tr><td><strong>Page<\/strong><\/td><td>String, optional, query params<\/td><td>The current page to get the paginated list<\/td><\/tr><tr><td><strong>PerPage<\/strong><\/td><td>String, optional, query params<\/td><td>The number of records to display per page<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<p><strong>Response:<\/strong><\/p>\n\n\n\n<figure class=\"wp-block-image size-full\"><img loading=\"lazy\" decoding=\"async\" width=\"1864\" height=\"3252\" src=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/Api-2.png\" alt=\"\" class=\"wp-image-3251\" srcset=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/Api-2.png 1864w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/Api-2-172x300.png 172w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/Api-2-587x1024.png 587w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/Api-2-768x1340.png 768w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/Api-2-29x50.png 29w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/Api-2-880x1536.png 880w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/Api-2-1174x2048.png 1174w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/Api-2-34x60.png 34w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/Api-2-57x100.png 57w\" sizes=\"auto, (max-width: 1864px) 100vw, 1864px\" \/><\/figure>\n\n\n\n<p><strong>Response Codes:<\/strong><\/p>\n\n\n\n<figure class=\"wp-block-image size-large\"><img loading=\"lazy\" decoding=\"async\" width=\"1024\" height=\"151\" src=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-63-1024x151.png\" alt=\"\" class=\"wp-image-3253\" srcset=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-63-1024x151.png 1024w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-63-300x44.png 300w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-63-768x113.png 768w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-63-50x7.png 50w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-63-60x9.png 60w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-63-100x15.png 100w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-63.png 1250w\" sizes=\"auto, (max-width: 1024px) 100vw, 1024px\" \/><\/figure>\n\n\n\n<p class=\"has-text-color has-medium-font-size\" style=\"color:#0303ab\"><strong>Daily Costing Time Transactions<\/strong><\/p>\n\n\n\n<p><strong>Endpoint:<\/strong><\/p>\n\n\n\n<figure class=\"wp-block-image size-full\"><img loading=\"lazy\" decoding=\"async\" width=\"920\" height=\"102\" src=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-64.png\" alt=\"\" class=\"wp-image-3255\" srcset=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-64.png 920w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-64-300x33.png 300w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-64-768x85.png 768w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-64-50x6.png 50w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-64-60x7.png 60w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-64-100x11.png 100w\" sizes=\"auto, (max-width: 920px) 100vw, 920px\" \/><\/figure>\n\n\n\n<p><strong>Description:<\/strong><\/p>\n\n\n\n<p>With this endpoint, the user will get the information about time transaction allocation which are broken down based on their worked departments and job costing.<\/p>\n\n\n\n<p><strong>Grouping:<br><\/strong> The transactions are grouped by<\/p>\n\n\n\n<ol class=\"wp-block-list\">\n<li>Shiftmatch date<\/li>\n\n\n\n<li>Time category<\/li>\n\n\n\n<li>Worked department and jobs<\/li>\n<\/ol>\n\n\n\n<p><strong>Request Parameters<\/strong>:<\/p>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td><strong>Parameter name<\/strong><\/td><td><strong>Type, mandatory\/optional, header\/Query Params<\/strong><\/td><td><strong>Description<\/strong><\/td><\/tr><tr><td><strong>AppRegion<\/strong><\/td><td>string, required, header<\/td><td>Use \u2018CAE\u2019 for Canada<br>Use \u2018USE2\u2019 for United States<\/td><\/tr><tr><td><strong>Authorization<\/strong><\/td><td>string, required, header<\/td><td>The authorization token, returned by <strong>\/v1\/authentication\/login,<\/strong> required to send this bearer token to the request<\/td><\/tr><tr><td><strong>StartDate<\/strong><\/td><td>String(date-time), optional, query params<\/td><td>The current date will be used if omitted.<br>(date format example: 2024-03-01)<\/td><\/tr><tr><td><strong>EndDate<\/strong><\/td><td>String(date-time), optional, query params<\/td><td>The current date will be used if omitted.<br>(date format example: 2024-03-01)<\/td><\/tr><tr><td><strong>EmployeeCodes<\/strong><\/td><td>String, optional, query params<\/td><td>Filter the punches by employee code(s)<\/td><\/tr><tr><td><strong>TcgFr<\/strong><\/td><td>String, optional, query params<\/td><td>The time category group in French to search on<\/td><\/tr><tr><td><strong>TcgEn<\/strong><\/td><td>String, optional, query params<\/td><td>The time category group in English to search on<\/td><\/tr><tr><td><strong>TcgSp<\/strong><\/td><td>String, optional, query params<\/td><td>The time category group in Spanish to search on<\/td><\/tr><tr><td><strong>DepartmentNumbers<\/strong><\/td><td>String, optional, query params<\/td><td>Filter the punches by department number(s)<\/td><\/tr><tr><td><strong>Page<\/strong><\/td><td>String, optional, query params<\/td><td>The current page to get the paginated list<\/td><\/tr><tr><td><strong>PerPage<\/strong><\/td><td>String, optional, query params<\/td><td>The number of records to display per page<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<p><strong>Response:<\/strong><\/p>\n\n\n\n<figure class=\"wp-block-image size-full\"><img loading=\"lazy\" decoding=\"async\" width=\"1476\" height=\"3440\" src=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/Api-3.png\" alt=\"\" class=\"wp-image-3257\" srcset=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/Api-3.png 1476w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/Api-3-129x300.png 129w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/Api-3-439x1024.png 439w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/Api-3-768x1790.png 768w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/Api-3-21x50.png 21w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/Api-3-659x1536.png 659w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/Api-3-879x2048.png 879w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/Api-3-26x60.png 26w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/Api-3-43x100.png 43w\" sizes=\"auto, (max-width: 1476px) 100vw, 1476px\" \/><\/figure>\n\n\n\n<p><\/p>\n\n\n\n<p><strong>Response Codes:<\/strong><\/p>\n\n\n\n<figure class=\"wp-block-image size-large\"><img loading=\"lazy\" decoding=\"async\" width=\"1024\" height=\"177\" src=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-65-1024x177.png\" alt=\"\" class=\"wp-image-3259\" srcset=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-65-1024x177.png 1024w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-65-300x52.png 300w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-65-768x133.png 768w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-65-50x9.png 50w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-65-1536x266.png 1536w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-65-60x10.png 60w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-65-100x17.png 100w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-65.png 1560w\" sizes=\"auto, (max-width: 1024px) 100vw, 1024px\" \/><\/figure>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td><strong>2.4 Punch<\/strong><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<p class=\"has-vivid-cyan-blue-color has-text-color has-large-font-size\">Punch<\/p>\n\n\n\n<p><strong>Endpoint:<\/strong><\/p>\n\n\n\n<figure class=\"wp-block-image size-full\"><img loading=\"lazy\" decoding=\"async\" width=\"496\" height=\"72\" src=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-66.png\" alt=\"\" class=\"wp-image-3262\" srcset=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-66.png 496w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-66-300x44.png 300w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-66-50x7.png 50w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-66-60x9.png 60w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-66-100x15.png 100w\" sizes=\"auto, (max-width: 496px) 100vw, 496px\" \/><\/figure>\n\n\n\n<p><strong>Description:<\/strong><\/p>\n\n\n\n<p>This endpoint will provide the list of punches with original and modified values. Original punches contain the punches that originated from the terminal. Modified punches include missing and updated punches.<\/p>\n\n\n\n<p><strong>Request Parameters<\/strong>:<\/p>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td><strong>Parameter name<\/strong><\/td><td><strong>Type, mandatory\/optional, header\/Query Params<\/strong><\/td><td><strong>Description<\/strong><\/td><\/tr><tr><td><strong>AppRegion<\/strong><\/td><td>string, required, header<\/td><td>Use \u2018CAE\u2019 for Canada<br>Use \u2018USE2\u2019 for United States<\/td><\/tr><tr><td><strong>Authorization<\/strong><\/td><td>string, required, header<\/td><td>The authorization token, returned by <strong>\/v1\/authentication\/login,<\/strong> required to send this bearer token to the request.<\/td><\/tr><tr><td><strong>PunchTypes<\/strong><\/td><td>String, optional, query params<\/td><td>A list of punch type and can have one or more values (In, Out, Break Begin, Break End, Department, Job)<\/td><\/tr><tr><td><strong>StartDate<\/strong><\/td><td>String(date-time), optional, query params<\/td><td>The current date will be used if omitted.<br>(date format example: 2024-03-01)<\/td><\/tr><tr><td><strong>EndDate<\/strong><\/td><td>String(date-time), optional, query params<\/td><td>The current date will be used if omitted.<br>(date format example: 2024-03-01)<\/td><\/tr><tr><td><strong>EmployeeCodes<\/strong><\/td><td>String, optional, query params<\/td><td>Filter the punches by employee code(s)<\/td><\/tr><tr><td><strong>DepartmentNumbers<\/strong><\/td><td>String, optional, query params<\/td><td>Filter the punches by department number(s)<\/td><\/tr><tr><td><strong>Page<\/strong><\/td><td>String, optional, query params<\/td><td>The current page to get the paginated list<\/td><\/tr><tr><td><strong>PerPage<\/strong><\/td><td>String, optional, query params<\/td><td>The number of records to display per page<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<p><strong>Response:<\/strong><\/p>\n\n\n\n<figure class=\"wp-block-image size-full\"><img loading=\"lazy\" decoding=\"async\" width=\"2504\" height=\"3880\" src=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/Api-4.png\" alt=\"\" class=\"wp-image-3265\" srcset=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/Api-4.png 2504w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/Api-4-194x300.png 194w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/Api-4-661x1024.png 661w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/Api-4-768x1190.png 768w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/Api-4-32x50.png 32w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/Api-4-991x1536.png 991w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/Api-4-1322x2048.png 1322w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/Api-4-39x60.png 39w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/Api-4-65x100.png 65w\" sizes=\"auto, (max-width: 2504px) 100vw, 2504px\" \/><\/figure>\n\n\n\n<p><strong>Response Codes:<\/strong><\/p>\n\n\n\n<figure class=\"wp-block-image size-large\"><img loading=\"lazy\" decoding=\"async\" width=\"1024\" height=\"178\" src=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-67-1024x178.png\" alt=\"\" class=\"wp-image-3267\" srcset=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-67-1024x178.png 1024w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-67-300x52.png 300w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-67-768x133.png 768w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-67-50x9.png 50w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-67-1536x267.png 1536w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-67-60x10.png 60w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-67-100x17.png 100w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-67.png 1634w\" sizes=\"auto, (max-width: 1024px) 100vw, 1024px\" \/><\/figure>\n\n\n\n<p class=\"has-vivid-cyan-blue-color has-text-color has-large-font-size\">Grosvenor<\/p>\n\n\n\n<p>Grosvenor endpoints help our customers to post punch requests to the system and use it to get a list of employees. Grosvenor has two below endpoints:<\/p>\n\n\n\n<figure class=\"wp-block-image size-full\"><img loading=\"lazy\" decoding=\"async\" width=\"668\" height=\"82\" src=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-70.png\" alt=\"\" class=\"wp-image-3273\" srcset=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-70.png 668w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-70-300x37.png 300w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-70-50x6.png 50w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-70-60x7.png 60w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-70-100x12.png 100w\" sizes=\"auto, (max-width: 668px) 100vw, 668px\" \/><\/figure>\n\n\n\n<p class=\"has-text-color has-medium-font-size\" style=\"color:#0303ab\"><strong>Grosvenor Punch<\/strong><\/p>\n\n\n\n<p><strong>Endpoint:<\/strong><\/p>\n\n\n\n<figure class=\"wp-block-image size-full\"><img loading=\"lazy\" decoding=\"async\" width=\"630\" height=\"106\" src=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-71.png\" alt=\"\" class=\"wp-image-3275\" srcset=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-71.png 630w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-71-300x50.png 300w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-71-50x8.png 50w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-71-60x10.png 60w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-71-100x17.png 100w\" sizes=\"auto, (max-width: 630px) 100vw, 630px\" \/><\/figure>\n\n\n\n<p><\/p>\n\n\n\n<p><strong>Description: <\/strong><\/p>\n\n\n\n<p>This endpoint helps the users to submit the employee\u2019s punches by providing information such as employee id, unique key, <strong>badge<\/strong>, punching info <strong>(punch type and punch time<\/strong>), and job values in the payload. These are used for clock integration. The API will perform some basic checks to ensure the required fields have been submitted and will return a corresponding response.<\/p>\n\n\n\n<p><strong>Required fields<\/strong>: For attendance punches (IN, OUT, BB, BE) Badge, Punch time, Punch type, Terminal and Unique key are required fields. Additionally, for department punches, punch type must be \u201cDEPT<a id=\"post-2599-_Int_uqtPzaxg\"><\/a>\u201d and department number must be provided in chvalue1. For job punches, punch type must be \u201cJOB\u201d and job values must be provided in chvalue1 to chvalue6.<\/p>\n\n\n\n<p><strong>Request Parameters<\/strong>:<\/p>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td><strong>Parameter name<\/strong><\/td><td><strong>Type, mandatory\/optional, header\/Query Params<\/strong><\/td><td><strong>Description<\/strong><\/td><\/tr><tr><td><strong>AppRegion<\/strong><\/td><td>string, required, header<\/td><td>Use \u2018CAE\u2019 for Canada<br>Use \u2018USE2\u2019 for United States<\/td><\/tr><tr><td><strong>Authorization<\/strong><\/td><td>string, required, header<\/td><td>The authorization token, returned by <strong>\/v1\/authentication\/login,<\/strong> required to send this bearer token to the request.<\/td><\/tr><tr><td><strong>Content-Type<\/strong><\/td><td>String, required, header<\/td><td>Use application\/json<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<p><strong>Note: <\/strong><\/p>\n\n\n\n<p><strong>Punch time format<\/strong>: \u201cyyyy-MM-ddTHH:mm:00zzz\u201d (Note: seconds should always be 00)<\/p>\n\n\n\n<p><strong>Punch type abbreviations<\/strong>:<\/p>\n\n\n\n<p><br>&#8220;IN&#8221; for <a id=\"post-2599-_Int_EquAkHTI\"><\/a>In punches<\/p>\n\n\n\n<p>&#8220;OUT&#8221; for Out punches<\/p>\n\n\n\n<p>&#8220;BB&#8221; for Break Begin punches<\/p>\n\n\n\n<p>&#8220;BE&#8221; for Break End punches<\/p>\n\n\n\n<p>&#8220;DEPT&#8221; for Department Punch punches<\/p>\n\n\n\n<p>&#8220;JOB&#8221; for Job Punch punches<\/p>\n\n\n\n<p><strong>Request Body<\/strong>:<\/p>\n\n\n\n<figure class=\"wp-block-image size-large\"><img loading=\"lazy\" decoding=\"async\" width=\"1024\" height=\"481\" src=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-72-1024x481.png\" alt=\"\" class=\"wp-image-3277\" srcset=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-72-1024x481.png 1024w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-72-300x141.png 300w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-72-768x361.png 768w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-72-50x23.png 50w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-72-60x28.png 60w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-72-100x47.png 100w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-72.png 1188w\" sizes=\"auto, (max-width: 1024px) 100vw, 1024px\" \/><\/figure>\n\n\n\n<p><strong>Response Codes:<\/strong><\/p>\n\n\n\n<figure class=\"wp-block-image size-large\"><img loading=\"lazy\" decoding=\"async\" width=\"1024\" height=\"123\" src=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-73-1024x123.png\" alt=\"\" class=\"wp-image-3279\" srcset=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-73-1024x123.png 1024w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-73-300x36.png 300w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-73-768x92.png 768w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-73-50x6.png 50w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-73-1536x185.png 1536w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-73-60x7.png 60w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-73-100x12.png 100w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-73.png 1580w\" sizes=\"auto, (max-width: 1024px) 100vw, 1024px\" \/><\/figure>\n\n\n\n<p class=\"has-text-color has-medium-font-size\" style=\"color:#0303ab\"><strong>Grosvenor Employee API<\/strong><\/p>\n\n\n\n<p><strong>Endpoint:<\/strong><\/p>\n\n\n\n<figure class=\"wp-block-image size-full\"><img loading=\"lazy\" decoding=\"async\" width=\"716\" height=\"106\" src=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-74.png\" alt=\"\" class=\"wp-image-3281\" srcset=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-74.png 716w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-74-300x44.png 300w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-74-50x7.png 50w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-74-60x9.png 60w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-74-100x15.png 100w\" sizes=\"auto, (max-width: 716px) 100vw, 716px\" \/><\/figure>\n\n\n\n<p><\/p>\n\n\n\n<p><strong>Description: <\/strong><\/p>\n\n\n\n<p>This endpoint returns all the active employees for the purposes of integrating with the terminals (physical and virtual clocks).<\/p>\n\n\n\n<p><strong>Request Parameters<\/strong>:<\/p>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td><strong>Parameter name<\/strong><\/td><td><strong>Type, mandatory\/optional, header\/Query Params<\/strong><\/td><td><strong>Description<\/strong><\/td><\/tr><tr><td><strong>AppRegion<\/strong><\/td><td>string, required, header<\/td><td>Use \u2018CAE\u2019 for Canada<br>Use \u2018USE2\u2019 for United States<\/td><\/tr><tr><td><strong>Authorization<\/strong><\/td><td>string, required, header<\/td><td>The authorization token, returned by <strong>\/v1\/authentication\/login,<\/strong> required to send this bearer token to the request.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<p><strong>Response:<\/strong><\/p>\n\n\n\n<figure class=\"wp-block-image size-full\"><img loading=\"lazy\" decoding=\"async\" width=\"1576\" height=\"1168\" src=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-75.png\" alt=\"\" class=\"wp-image-3283\" srcset=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-75.png 1576w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-75-300x222.png 300w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-75-1024x759.png 1024w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-75-768x569.png 768w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-75-50x37.png 50w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-75-1536x1138.png 1536w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-75-60x44.png 60w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-75-100x74.png 100w\" sizes=\"auto, (max-width: 1576px) 100vw, 1576px\" \/><\/figure>\n\n\n\n<p><\/p>\n\n\n\n<p><strong>Response Codes:<\/strong><\/p>\n\n\n\n<figure class=\"wp-block-image size-large\"><img loading=\"lazy\" decoding=\"async\" width=\"1024\" height=\"121\" src=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-76-1024x121.png\" alt=\"\" class=\"wp-image-3285\" srcset=\"\/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-76-1024x121.png 1024w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-76-300x36.png 300w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-76-768x91.png 768w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-76-50x6.png 50w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-76-1536x182.png 1536w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-76-60x7.png 60w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-76-100x12.png 100w, \/agile\/wp-content\/uploads\/sites\/2\/2024\/08\/image-76.png 1704w\" sizes=\"auto, (max-width: 1024px) 100vw, 1024px\" \/><\/figure>\n\n\n\n<p>&#8212;&#8212;&#8212;****&#8212;&#8212;&#8212;<\/p>\n","protected":false},"excerpt":{"rendered":"<p>Customer APIs are built to provide flexibility to our users to get information or post data from\/to the database. It allows external entities (like customers, partners, or connector products) to call a Synerion Agile API to get or post data. The API can be used for the following major use&#8230;<\/p>\n","protected":false},"author":4,"comment_status":"closed","ping_status":"closed","template":"","format":"standard","meta":{"_lmt_disableupdate":"","_lmt_disable":"","footnotes":""},"ht-kb-category":[187],"ht-kb-tag":[],"class_list":["post-2599","ht_kb","type-ht_kb","status-publish","format-standard","hentry","ht_kb_category-clocks-integration"],"_links":{"self":[{"href":"https:\/\/help.synerion.com\/agile\/wp-json\/wp\/v2\/ht-kb\/2599","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/help.synerion.com\/agile\/wp-json\/wp\/v2\/ht-kb"}],"about":[{"href":"https:\/\/help.synerion.com\/agile\/wp-json\/wp\/v2\/types\/ht_kb"}],"author":[{"embeddable":true,"href":"https:\/\/help.synerion.com\/agile\/wp-json\/wp\/v2\/users\/4"}],"replies":[{"embeddable":true,"href":"https:\/\/help.synerion.com\/agile\/wp-json\/wp\/v2\/comments?post=2599"}],"version-history":[{"count":6,"href":"https:\/\/help.synerion.com\/agile\/wp-json\/wp\/v2\/ht-kb\/2599\/revisions"}],"predecessor-version":[{"id":3287,"href":"https:\/\/help.synerion.com\/agile\/wp-json\/wp\/v2\/ht-kb\/2599\/revisions\/3287"}],"wp:attachment":[{"href":"https:\/\/help.synerion.com\/agile\/wp-json\/wp\/v2\/media?parent=2599"}],"wp:term":[{"taxonomy":"ht_kb_category","embeddable":true,"href":"https:\/\/help.synerion.com\/agile\/wp-json\/wp\/v2\/ht-kb-category?post=2599"},{"taxonomy":"ht_kb_tag","embeddable":true,"href":"https:\/\/help.synerion.com\/agile\/wp-json\/wp\/v2\/ht-kb-tag?post=2599"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}