DOCSEARCHbyAlgolia
Submit Docs

Terros OpenAPI Documentation

website·Indexed 31 days ago

https://docs.terros.com/

API reference for Terros, featuring endpoints for task management, team and permission administration, KPI reporting, calendar event scheduling, and data import/export operations.

Tokens
11K
Snippets
103
Records
130
Agent score
50%

What's inside Terros

  1. Overview of Terros API capabilities

    The Terros API allows developers to integrate Terros services into external applications to automate workflows and build custom dashboards or analytics tools. Key capabilities include user authentication, session management, and the generation and retrieval of various report types. The API uses JSON for all request and response bodies.

  3. Retrieve detailed information for a calendar event

    Use the /calendar/event/get endpoint to retrieve comprehensive details about a specific calendar event. The response includes information regarding the event owner, the list of attendees, and associated teams.
    POST /calendar/event/get

  4. Retrieve user information using the /user/get endpoint

    Use the POST /user/get endpoint to retrieve detailed information about a user. You can specify a userId or an email to fetch a specific user's data; if no identifier is provided, the API defaults to returning information for the currently authenticated user. A successful request returns a 200 status code.
    curl -X POST "https://<api-domain>/user/get"

  6. Bulk import data using the Terros Import API

    The Terros Import API allows for asynchronous bulk imports of CSV files. The process follows a three-step flow: initiate the import to get a pre-signed S3 upload URL, upload the CSV file via PUT, and poll the status endpoint until the process is complete. Supported entity types for import include Account, CalendarEvent, User, Task, and Recruit.

  7. Update account filtering and searching for Workflows

    When using POST /account/list, migrate from statusIds (legacy) to the following workflow-based filters:

    • workflowId: Filter by the specific pipeline.
    • stageIds: Filter by workflow stages.
    • actionIds: Find accounts based on their last workflow action.

  8. Monitor assignment run progress

    Since the /area/assign operation is asynchronous, you must poll the /area/get endpoint to track progress. Check the jobInfo field for the current status of the assignment run. Possible statuses include: preparing, queued, running, and completed.

  9. Authenticate requests to the Terros API

    The Terros API uses API key authentication. To authenticate a request, include an Authorization header with the value ApiKey followed by a space and your specific API key.
    Authorization: ApiKey YOUR_API_KEY

  10. Install Terros CLI via npm

    The Terros CLI is available as an npm package. After installation, use the terros auth login command to authenticate your account.
    npm install -g @terros-inc/cli
terros auth login

  11. Secure Terros API keys

    Terros API keys are secrets and grant full access to your user account. To prevent exposure:

    1. Use environment variables (e.g., a .env file) and ensure they are added to .gitignore.
    2. Keep keys server-side only; never embed them in client-side JavaScript, mobile apps, or desktop clients.
    3. Rotate keys immediately via the API keys page if they are compromised.

  12. Update account data writes for Workflows

    When creating or updating accounts via POST /account/upsert, use the workflowActionOrStageId field instead of statusId. This field accepts either a workflow action ID (A.xxx) or a stage ID (S.xxx).

    Recommendation: Use an action ID (A.xxx) to ensure the action is recorded in the account's workflow history rather than just updating the current stage.