> ## Documentation Index > Fetch the complete documentation index at: https://docs.helloannie.com/llms.txt > Use this file to discover all available pages before exploring further. # List conversations > Return a paginated list of conversations. By default, returns conversations for the authenticated organization, sorted by creation date (newest first). Archived conversations are excluded by default. For account organizations, use `includeChildren=true` to include conversations from child organizations. ## OpenAPI ````yaml /openapi/openapi.yaml get /conversations openapi: 3.0.3 info: title: Annie API description: > ### Overview The Annie API is a (mostly) RESTful API. Typically, both POST bodies and responses are JSON-encoded. Note: The documenation is Work In Progress and is subject to change. ### Base URL The base URL for the Annie API is https://api.helloannie.com/. Examples in this document may abbreviate this to `/`. ### Versioning Routes are prefixed with a version number i.e. `v1`. The version will change when there is a non-backwards compatible or other significant change to the api. ### Authentication The Annie API supports two authentication methods API Keys and OAuth Access Tokens: #### API Keys API Keys are long-lived tokens that can be generated from the Developer Portal on your organization page. API keys are prefixed with `annie-sk-v2-` and can be used directly in the `Authorization` header. ``` curl -H "Authorization: Bearer annie-sk-xxxxx" https://api.helloannie.com/... ``` #### OAuth Tokens OAuth tokens are short-lived access tokens generated using the OAuth 2.0 Client Credentials flow (Machine-to-Machine). OAuth clients provide scoped permissions and are ideal for server-to-server integrations. **Creating an OAuth Client** OAuth clients can be created in the Developer Portal on your organization page. When creating a client, you'll receive: - `client_id`: Your OAuth client identifier - `client_secret`: Your OAuth client secret (store this securely) **Generating an OAuth Token** To generate an OAuth access token, make a POST request to the Annie OAuth token endpoint: **Endpoint:** `https://annie-external-api.us.auth0.com/oauth/token` **Example Request:** ```bash curl -X POST https://annie-external-api.us.auth0.com/oauth/token \ -H "Content-Type: application/json" \ -d '{ "grant_type": "client_credentials", "client_id": "your-client-id", "client_secret": "your-client-secret", "audience": "https://api.helloannie.com" }' ``` The `access_token` from the response should be used in the `Authorization` header when making requests to the Annie API: ``` curl -H "Authorization: Bearer eyJhbGciOiJSUzI..." https://api.helloannie.com/v1/... ``` ### API Response Structure The Annie API returns status codes consistent with standard HTTP conventions. Success and Error responses follow the below structure: ``` { "success": boolean "data": {} "message": string // optional } ``` ### Rate Limiting The Annie API enforces rate limits to ensure stability and fair usage. The default rate limit is **60 requests per minute** per organization. This limit is applied per endpoint pattern (e.g. `GET /v1/bots/:id`). When the rate limit is exceeded, the API responds with HTTP `429 Too Many Requests`. Response headers include: - `X-RateLimit-Limit`: The maximum number of requests allowed in the current window. - `X-RateLimit-Remaining`: The number of requests remaining in the current window. - `X-RateLimit-Reset`: The time at which the current rate limit window resets (in UTC epoch seconds). If you exceed the limit, the response will contain a `Retry-After` header indicating how many seconds to wait before retrying. ### Pagination The Annie API does not currently support pagination. All results are returned at once. version: v1 servers: - url: https://api.helloannie.com/v1 security: [] paths: /conversations: get: tags: - Conversations summary: List conversations description: >- Return a paginated list of conversations. By default, returns conversations for the authenticated organization, sorted by creation date (newest first). Archived conversations are excluded by default. For account organizations, use `includeChildren=true` to include conversations from child organizations. operationId: getV1Conversations parameters: - name: offset in: query required: false schema: minimum: 0 default: 0 description: Number of items to skip type: number - name: limit in: query required: false schema: minimum: 1 maximum: 100 default: 20 description: Number of items to return (max 100) type: number - name: orgId in: query required: false schema: format: uuid description: Filter conversations by a specific organization ID type: string - name: botId in: query required: false schema: format: uuid description: Filter conversations by a specific bot ID type: string - name: includeArchived in: query required: false schema: default: false description: Include archived conversations in the results type: boolean - name: includeChildren in: query required: false schema: default: false description: >- Include conversations from child organizations (only applicable for account orgs) type: boolean responses: '200': description: Response returned when listing conversations with pagination content: application/json: schema: $ref: '#/components/schemas/ConversationListResponse' '403': description: You do not have permission to perform this action content: application/json: schema: $ref: '#/components/schemas/ForbiddenResponse' '404': description: The requested resource was not found content: application/json: schema: $ref: '#/components/schemas/NotFoundResponse' components: schemas: ConversationListResponse: additionalProperties: false type: object required: - success - data properties: success: enum: - true type: boolean data: type: object required: - conversations - pagination properties: conversations: type: array items: additionalProperties: false description: >- High-level information about a conversation including summary metadata type: object required: - conversationId - conversationTags - orgId - medium - botId - toNumber - fromNumber - summary - billed - actionsNeeded - topic - duration - startTime - endTime - status properties: conversationId: format: uuid type: string conversationTags: type: array items: type: string orgId: format: uuid type: string medium: type: string enum: - CHAT - PHONE - SMS botId: format: uuid type: string nullable: true toNumber: type: string nullable: true fromNumber: type: string nullable: true summary: type: string nullable: true billed: description: Whether this conversation has been counted as billable. type: boolean actionsNeeded: description: Follow-up actions needed after the conversation type: array items: type: string topic: type: string nullable: true duration: description: Duration of the conversation in milliseconds example: 1500 type: number nullable: true startTime: type: string format: date-time nullable: true endTime: type: string format: date-time nullable: true status: type: string enum: - OPEN - CLOSED pagination: additionalProperties: false description: Metadata about pagination for a list response type: object required: - offset - limit - totalCount properties: offset: description: Current offset type: number limit: description: Number of items per page type: number totalCount: description: Total number of items across all pages type: number ForbiddenResponse: additionalProperties: false type: object required: - success - data - message properties: success: enum: - false type: boolean data: additionalProperties: false type: object properties: {} message: type: string NotFoundResponse: additionalProperties: false type: object required: - success - data - message properties: success: enum: - false type: boolean data: additionalProperties: false type: object properties: {} message: type: string ````