Missive Contact Books API

List available contact books

OpenAPI Specification

missive-contact-books-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: Missive REST Analytics Contact Books API
  description: The Missive REST API allows developers to manage conversations, messages, contacts, drafts, labels, and analytics programmatically. Authentication uses Bearer tokens (personal access tokens) generated in Missive preferences. The API requires a Productive plan or higher to generate API tokens. Responses are JSON-formatted with HTTP 200 or 201 success codes.
  version: '1'
  contact:
    name: Missive Support
    url: https://missiveapp.com/help
  termsOfService: https://missiveapp.com/terms
servers:
- url: https://public.missiveapp.com/v1
  description: Missive REST API v1
security:
- bearerAuth: []
tags:
- name: Contact Books
  description: List available contact books
paths:
  /contact_books:
    get:
      operationId: listContactBooks
      summary: List Contact Books
      description: List contact books the authenticated user has access to.
      tags:
      - Contact Books
      parameters:
      - name: limit
        in: query
        description: Maximum number of results (default 50, max 200)
        schema:
          type: integer
          default: 50
          maximum: 200
      - name: offset
        in: query
        schema:
          type: integer
      responses:
        '200':
          description: Array of contact book objects
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContactBooksResponse'
components:
  schemas:
    ContactBook:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        shared:
          type: boolean
    ContactBooksResponse:
      type: object
      properties:
        contact_books:
          type: array
          items:
            $ref: '#/components/schemas/ContactBook'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Personal access token generated in Missive preferences. Format: Bearer missive_pat-[token]. Requires Productive plan or higher.'
externalDocs:
  description: Missive Developer Documentation
  url: https://missiveapp.com/docs/developers/rest-api