Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Sliq Public Agents API
version: 0.1.0
description: Sliq's public API — programmatic read access to your GTM data for CRM sync and coding agents. v1 exposes your outreach prospects, their cross-channel interaction history, and your agents (campaigns); more resources follow over time. Read-only, bearer-authenticated, cursor-paginated, and scoped to the key owner.
servers: []
tags:
- name: Agents
paths:
/v1/agents:
get:
operationId: publicapi_api_list_agents
summary: List Agents
parameters:
- in: query
name: page_size
schema:
anyOf:
- type: integer
- type: 'null'
description: Rows per page, 1–100 (default 100).
title: Page Size
required: false
description: Rows per page, 1–100 (default 100).
- in: query
name: cursor
schema:
anyOf:
- type: string
- type: 'null'
description: Opaque cursor copied from a prior response's next_url; omit for the first page.
title: Cursor
required: false
description: Opaque cursor copied from a prior response's next_url; omit for the first page.
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PagedAgentOut'
description: 'The owner''s agents (campaigns) — resolve the `agent_id` on each person to a
name here. Soft-deleted campaigns are excluded; cursor-paginated on `id`.'
security:
- ApiKeyAuth: []
tags:
- Agents
components:
schemas:
AgentOut:
properties:
id:
description: Stable Sliq agent (campaign) id; the value `agent_id` carries on each person.
title: Id
type: integer
name:
description: Campaign name.
title: Name
type: string
status:
description: Lifecycle status.
enum:
- active
- running
- paused
title: Status
type: string
created_at:
format: date-time
title: Created At
type: string
updated_at:
format: date-time
title: Updated At
type: string
required:
- id
- name
- status
- created_at
- updated_at
title: AgentOut
type: object
PagedAgentOut:
properties:
data:
items:
$ref: '#/components/schemas/AgentOut'
title: Data
type: array
next_url:
anyOf:
- type: string
- type: 'null'
title: Next Url
has_more:
title: Has More
type: boolean
required:
- data
- has_more
title: PagedAgentOut
type: object
securitySchemes:
ApiKeyAuth:
type: http
scheme: bearer
x-provenance:
method: harvested
publisher: Sliq
source: https://getsliq.com/openapi.json
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)