canonical: https://jentic.com/apis/surveysparrow.com/surveysparrow # Surveysparrow API Documentation --- **Introduction** SurveySparrow API allows you to integrate third party applications in your enterprise ecosystem and helps you to automate workflows like, sending a survey when a ticket is closed or a employee leaves the organisation. Request & Response Format SurveySparrow API accepts HTTPS requests with JSON Arguments. The response will be in JSON format. Our Authentication is based on OAuth. The API exposes 251 endpoints secured with bearer authentication. ## For AI agents Programmatically list audit logs, create contact list. Covers 251 operations with bearer authentication. ## Scope Does not handle payments, communications, or crm - use for identity and authentication only. ## Capabilities - List audit logs - Create contact list - Get Contacts - Query and filter API Documentation records by parameters - Monitor API Documentation operational status and events ## Use cases ### Identity and Authentication Operations Use the API Documentation to perform identity auth operations programmatically. The API provides 251 endpoints covering core functionality including list audit logs, create contact list, list contact lists. Example prompt: Call GET /v1/audit-logs to list audit logs ### Automated accounts Management Automate accounts operations by combining multiple API Documentation endpoints. Agents can create contact list and then list contact lists in a single workflow. Example prompt: Call POST /v1/contactlist to create contact list, then verify the result ### AI Agent Integration via Jentic AI agents discover and call API Documentation endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle bearer tokens manually. Example prompt: Search Jentic for 'list audit logs', load the operation schema, and execute with Jentic-managed credentials ## Key endpoints | Method | Path | Description | | --- | --- | --- | | GET | /v1/audit-logs | List audit logs | | POST | /v1/contactlist | Create contact list | | GET | /v1/contactlist | List contact lists | | POST | /v1/contacts | Create contact | | GET | /v1/contacts | Get Contacts | | GET | /v1/roles | List roles | | POST | /v1/surveys | Create survey | | GET | /v1/surveys | Get surveys | ## Key resources - **accounts** — Operations related to accounts - **audit_logs** — Operations related to audit_logs - **ces** — Operations related to ces - **channels** — Operations related to channels - **contact_list** — Operations related to contact_list ## Why Jentic - **Setup:** Wiring SurveySparrow by hand means setting up its bearer token auth against the api.surveysparrow.com host and mapping its many contact, survey, and audit operations yourself. Through Jentic you install once, import the SurveySparrow API from the API Directory, store the bearer token once, and your agent calls it. - **Permission scoping:** These SurveySparrow operations carry their targets in the request body or query, so scope your agent to the operations it needs, such as listing surveys or reading audit logs. You choose that set, so a write like creating contacts or contact lists is only included if you add it. - **Credential handling:** Your SurveySparrow bearer token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'list audit logs' or 'create a contact list', and Jentic returns the matching SurveySparrow operation with its input schema so the agent calls the right endpoint without browsing the reference docs. ## Related APIs - **Auth0** — Alternative identity auth API - **Okta** — Alternative identity auth API ## FAQ ### What authentication does the API Documentation use? The API Documentation uses a Bearer token in the Authorization header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context. ### Can I list audit logs with the API Documentation? Yes. Use the GET /v1/audit-logs endpoint. The API returns structured JSON responses that agents can parse and act on directly. ### What are the rate limits for the API Documentation? Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer. ### How do I list audit logs through Jentic? Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'list audit logs'. Jentic returns the matching API Documentation operation with its input schema. Load the schema and execute the call - credentials are injected automatically. ### How many endpoints does the API Documentation have? The API Documentation exposes 251 endpoints covering accounts, audit_logs, ces operations. ### Can I limit what my agent is allowed to do with the SurveySparrow API? Yes. Because you run Jentic One yourself, your own rules decide which SurveySparrow operations and credentials the agent may use. Since each operation carries its target in the request body or query, you scope the agent to only the calls it needs, such as GET /v1/surveys to list surveys or GET /v1/audit-logs to read audit logs. A write like POST /v1/contacts or POST /v1/contactlist is available only if you explicitly add it to that set.