Olark
Retrieve operator and group information and update operator availability in Olark live chat via the Olark REST API v1.
Operations
| Operation | Description | Required params |
|---|---|---|
list_operators |
List all operators on the account (paginated, max 100) | — |
get_operator |
Retrieve details for a single operator | operatorId |
list_groups |
List all operator groups with member IDs | — |
set_operator_availability |
Mark an operator available or away | operatorId, available |
API Key Setup
- Log in to your Olark dashboard.
- Go to Settings → Integrations → API.
- Copy the API Key shown on that page.
The API key is account-scoped — keep it secret and transmit it only over HTTPS.
Examples
List all operators:
apiKey: YOUR_OLARK_API_KEY
operation: list_operators
Get details for a specific operator:
apiKey: YOUR_OLARK_API_KEY
operation: get_operator
operatorId: abc123
List all operator groups:
apiKey: YOUR_OLARK_API_KEY
operation: list_groups
Mark an operator as unavailable (away):
apiKey: YOUR_OLARK_API_KEY
operation: set_operator_availability
operatorId: abc123
available: false
Mark an operator as available:
apiKey: YOUR_OLARK_API_KEY
operation: set_operator_availability
operatorId: abc123
available: true
Auth
API key is appended as a ?apikey= query parameter on every request to https://www.olark.com/api/v1. No OAuth flow is required — a single key string is all that is needed.
Notes
- Transcripts are delivered via Olark webhooks (push to your endpoint on conversation end) — there is no REST endpoint to pull historical transcripts.
- Rate limits are enforced server-side; the tool surfaces HTTP 429 in the
statusoutput so you can detect throttling. set_operator_availabilityuses full PUT semantics — onlyavailableis sent, which is the documented pattern for toggling availability without resetting other operator fields.