Skip to main content

Agents

Retrieve all active agents for a specific company using company ID and Cognivo code.

Endpoint

Authentication

Bearer Token RequiredThe token must be valid for agent endpoint and POST method.

Input Parameters

Body Parameters

integer
required
Unique identifier of the company
string
required
Cognivo code of the company (must be non-empty)

Responses

Example 1: Get company agents

Important Considerations

Validations

  • Bearer token must be valid and properly formatted
  • company_id must be a valid integer
  • code must be a non-empty string
  • Company must exist with provided ID and code

Behavior

  • Returns only active agents
  • Agent descriptions are HTML cleaned
  • Results are filtered by company ownership
  • Empty results return valid response with 0 agents

Limits

  • Fast lookup using indexed company fields
  • Efficient agent filtering by active status
  • No specific limit on number of agents returned

Troubleshooting

Solution: Contact your system administrator to verify the company ID and code combination.
Solution: Ensure both company_id and code are included in the request body.
Solution: Check that your Authorization header follows the format: Bearer {token}.
Solution: This is normal if the company has no active agents. Contact your system administrator to verify agent status.
Version: 1.0
Last updated: 2025-01-13