API and integrations

Focoosin API allows your existing system to integrate with us.

23 articles in this category

API - Common Error handling

Focoosin API will return an JSON error message with the following fields:type: Exception type (required) message: A message (required) user_message: A message for end-user and translated (optional). This could be used in places where a message ...

API - Organization

  Get organization information Request GET /api/latest/organization/ Response   { "created_on":"2018-12-25T20:34:18.126Z", "updated_on":"2018-12-25T20:34:19.643Z", "company_key":"173f9a93-f40a-401e-88d9-6a1d6b4cd25f", "full_nam...

API - Organization - Logo (image)

This endpoint allows to upload and retrieves the organization logo. Files are stored securely using AWS (Amazon Web Services) Upload or update the organization logo Request Verb: PUT Request URL:  /api/latest/organization/logo/{image-name.exten...

API - Organization - Job Titles

This point allows admin users to create new Job Title within their organization.  Create a Job Title POST: /api/latest/company/job-titles/ Request Example: This example adds a job description with name "Ingeniero en comunicación" and descript...

API - Organization - Roles

This API allows view, create or edit Organization Roles In Focoosin, Roles are used to defining permissions for users. A user holding a Role "A" which have all permission defined for Role "A". You can use the role pre-defined in Focoosin or yo...

API - Organization - Notifications

Its allow to read and configure organization notifications. Properties: members_can_edit: When True, the users within the organization can change their notifications settings. When false, users are not authorized to change their notificat...

API - User

Get user information Get (logged in user information) GET /api/latest/user/ Get (user_key information) focoosin.com/api/latest/user/{user_key}/ URL composition: user_key: Key of the user to retrieve information. Parameters:...

API - User - Notification Settings

Its allow to read and configure user notifications. Properties and expected behavior: edit_permission: This field indicates if a user can edit this setting. When the field is False, UI should be disabled. because those settings are ha...

API - User - Update password (by user it self)

Endpoint: HTTP verb and endpoint: POST /api/latest/user/set-password/ Payload: { "old_password":"myoldpassword", "new_password1":"mynewPassword", "new_password2":"mynewPassword" } Responses: 200 if the password was updated succe...

API - User - Set new password

Self-set new password (authenticated user) Request POST /api/latest/user/set-password/ Request payload { "old_password":"myoldpassword", "new_password1":"myNewPassword", "new_password2":"myNewPassword" } Response Set new password t...

API - User - Profile picture

This endpoint allows upload, overwrite and delete profile picture of the logged-in user. Upload or replace profile picture: Request required header: content type: image/<format> URL: PUT /api/latest/user/avatar/<image-name.extension> r...

API - User - Logout from all devices (client)

This request remove all users tokens used by connected devices.  This could be used when a user no longer has access to a computer where Focoosin was installed with their account.  Request POST /api/latest/user/logout-from-devices/ Response...

Third party integrations.

Focoosin can have integration with Youtrack to import task through Focoosin. To ask for another integration contact us to alvaro@focoosin.com  

API - User - Change Email

This request remove all users tokens used by connected devices.  This could be used when a user no longer has access to a computer where Focoosin was installed with their account.  Request POST /api/latest/user/request-update-email/ Req...

API - Users

It does list users based on parameters (filter) URL: /api/latest/users/ Parameters: No parameters defined Response: An array of zero or more Users  

API - Lookups - Countries and Languages

Languages List of accepted languages by Focoosin platform. List all languages: URL GET /api/latest/lookups/languages/ Response:   { "en":"English", "es":"Spanish" } List of countries names and code accepted by Focoosin API. ...

API - Lookup - Search prefilled job titles

Allow search for job titles. This could be used in the pre-fill text box when a user is creating Job Titles in their organization. Get: /api/latest/lookups/search-prefill-job-titles/?q={search-term} Parameters: q: A term to search, for exam...

API - Lookups - Localization - Valid Time Zones

It returns a list of accepted values for time zone API fields. Request: /api/latest/lookups/time-zones/ Response:   [ "Africa/Abidjan", "Africa/Accra", "Africa/Addis_Ababa", "Africa/Algiers", "Africa/Asmara", "Africa/Asmera", "Afr...

API - Lookups - Date and Time formats

Its endpoints allow requesting date and time available formats accepted by Focoosin API. Date Request: GET /api/latest/lookups/date-format/ Response: [ "DMY", "YMD", "MDY" ]   Time Request GET /api/latest/lookups/time-format...

API - Lookups - Valid Idle Times

It returns a list of accepted values for idle_time_threshold field of User. The value is the number of miliseconds transcurred since last time user have interacted with the computer. After that time, the user will be considered idle or away  ...

API - Teams

Those endpoints allow to create, edit and remove Teams. Create a team Request: POST /api/latest/teams/ { "name":"Team 1", "identifier":"Team1", "admins":[ "44a69e4a3fca4507960936c138047f35" ], "members":[ "44a69e4a3...

API - Organization - Delete All Data

This article describes the steps required to request delete all account data: As data delete is an important action, it's designed to be a two-phase process: 1) Get a unique token from the server. 2) Request delete the data using the token...

API - Organization - Delete account

This article describes the steps required to request delete a Focoosin account. Warning: Using the procedure described here will delete your whole account (organization) and all your data In order to prevent delete an account inadvertently, ...