Lytics

Lytics Auth API

API for creation or storage of auth tokens. Most of these tokens are created from the Integrations/Imports setup for Lytics integrations. Additionally, api tokens can be created/managed from this endpoint. The oauth, config information are write only attributes that cannot be subsequently read from the api, and is stored encrypted.

GitHub OpenAPI

Operations 5

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api/auth/{id} Get an integration auth's public details · Retrieve a Single Auth #
Ask an LLM
“Can I look up a stored integration credential without exposing its secrets?”
“Which parts of an auth record are visible when I fetch it?”
Tell an agent
Show me the public details of auth {id}.
Fetch integration auth {id}.
POST /api/auth/{id} Create an integration auth · Create Auth #
Ask an LLM
“Can I create an integration auth through the API instead of the Integrations admin page?”
“What config does a new auth need for a provider?”
Tell an agent
Create auth {id} for provider {provider_id}.
Add a new integration auth {id} with config {config}.
PUT /api/auth/{id} Update an integration auth · Update Auth #
Ask an LLM
“Can I edit an existing integration auth record?”
“Is it possible to modify a saved credential for an integration?”
Tell an agent
Update integration auth {id}.
Edit the saved auth {id} with new details.
DELETE /api/auth/{id} Delete an integration auth · Remove an Auth #
Ask an LLM
“What happens to running imports and exports when I delete an auth?”
“Can I remove a stored integration credential?”
Tell an agent destructive · confirm first
Delete integration auth {id}.
Remove auth {id} and stop any work using it.
POST /api/auth/createtoken Create an API token · Auth Create Token #
Ask an LLM
“How do I generate a new Lytics API token?”
“Can I give an API token specific scopes and an expiry?”
Tell an agent
Create an API token named {name} with scopes {scopes}.
Generate a new API token that expires {expires}.

Documentation

📖
Documentation
https://docs.lytics.com/reference
📖
APIReference
https://docs.lytics.com/reference

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/lytics/refs/heads/main/openapi/lytics-auth-api-openapi.yml

Other Resources

🔗
OpenAPI Source
https://dash.readme.com/api/v1/api-registry/1y876emrv8pb2i
🔗
ToolCrosswalk
https://raw.githubusercontent.com/api-evangelist/lytics/refs/heads/main/mcp/lytics-tool-crosswalk.yml
🔗
OpenAPI Source
https://dash.readme.com/api/v1/api-registry/10ej22ml8a94fx

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/lytics:lytics-auth-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

lytics-auth-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: V1 Lytics Auth API
  version: 1.0.0
  description: 'The Lytics API is a _restful_ *JSON* api that includes:

    * *Data Collection* api''s for collection, and upload of custom data.'
servers:
- url: https://api.lytics.io
tags:
- name: Auth
  description: 'API for creation or storage of auth tokens. Most of these

    tokens are created from the Integrations/Imports setup for Lytics integrations.


    Additionally, api tokens can be created/managed from this endpoint.


    The oauth, config information are write only attributes that

    cannot be subsequently read from the api, and is stored encrypted.'
paths:
  /api/auth/{id}:
    get:
      responses:
        '200':
          description: JSON representation of Auth Resource in addition to representing its state in the JSON.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthModel'
              examples:
                response:
                  value:
                    status: success
                    data:
                      account_id: 4f7b525bdba058fc096757a6
                      id: 1b53b88a06b418b07d601b6f57b8eb40
                      provider_id: 26cae7718c32180a7a0f8e19d6d40a59
                      provider_name: Facebook
                      user_id: 4222fd7c8db7ebcb042e0547e3b4e128
      security:
      - ApiKeyAuth: []
      summary: Retrieve a Single Auth
      operationId: RetrieveASingleAuth
      description: 'This API is fairly special, as only the public portions of the auth model are

        returned, not all fields **config**, **oauth2token**, and **oathtoken** fields are

        never exposed.'
      tags:
      - Auth
      parameters:
      - name: account_id
        in: query
        description: Your Lytics account ID.
        required: false
        schema:
          type: string
      - name: id
        in: path
        description: ID of the Gist in the form of a hash.
        required: true
        schema:
          type: string
      - name: access_token
        in: query
        description: Lytics API access token.
        required: false
        schema:
          type: string
      x-operation-id-source: normalized
      x-operation-id-original: Retrieve a Single Auth
    post:
      responses:
        '201':
          description: JSON representation of Auth Resource in addition to representing its state in the JSON.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthModel'
              examples:
                response:
                  value:
                    status: success
                    data:
                      account_id: 4f7b525bdba058fc096757a6
                      id: 1b53b88a06b418b07d601b6f57b8eb40
                      provider_id: 26cae7718c32180a7a0f8e19d6d40a59
                      provider_name: Facebook
                      user_id: 4222fd7c8db7ebcb042e0547e3b4e128
      security:
      - ApiKeyAuth: []
      summary: Create Auth
      operationId: CreateAuth
      description: 'Create an auth, would normally never be used via the api, the web admin

        Integrations section manages these.'
      tags:
      - Auth
      parameters:
      - name: account_id
        in: query
        description: Your Lytics account ID.
        required: false
        schema:
          type: string
      - name: id
        in: path
        description: ID of the Gist in the form of a hash.
        required: true
        schema:
          type: string
      - name: access_token
        in: query
        description: Lytics API access token.
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                provider_id:
                  type: string
                config:
                  type: array
                  items:
                    type: object
                    properties:
                      name:
                        type: string
                      value:
                        type: string
              example:
                provider_id: our_provider
                config:
                - name: apikey
                  value: value_that_will_get_encrypted
      x-operation-id-source: normalized
      x-operation-id-original: Create Auth
    put:
      responses:
        '200':
          description: JSON representation of Auth Resource in addition to representing its state in the JSON.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthModel'
              examples:
                response:
                  value:
                    status: success
                    data:
                      account_id: 4f7b525bdba058fc096757a6
                      id: 1b53b88a06b418b07d601b6f57b8eb40
                      provider_id: 26cae7718c32180a7a0f8e19d6d40a59
                      provider_name: Facebook
                      user_id: 4222fd7c8db7ebcb042e0547e3b4e128
      security:
      - ApiKeyAuth: []
      summary: Update Auth
      operationId: UpdateAuth
      description: ''
      tags:
      - Auth
      parameters:
      - name: account_id
        in: query
        description: Your Lytics account ID.
        required: false
        schema:
          type: string
      - name: id
        in: path
        description: ID of the Gist in the form of a hash.
        required: true
        schema:
          type: string
      - name: access_token
        in: query
        description: Lytics API access token.
        required: false
        schema:
          type: string
      x-operation-id-source: normalized
      x-operation-id-original: Update Auth
    delete:
      responses:
        '204':
          description: No Content
          headers: {}
      security:
      - ApiKeyAuth: []
      summary: Remove an Auth
      operationId: RemoveAnAuth
      description: 'Deleting an auth is a very special operation. If any work is running (imports, exports),

        it will remove the auth from those works and stop them.'
      tags:
      - Auth
      parameters:
      - name: account_id
        in: query
        description: Your Lytics account ID.
        required: false
        schema:
          type: string
      - name: id
        in: path
        description: ID of the Gist in the form of a hash.
        required: true
        schema:
          type: string
      - name: access_token
        in: query
        description: Lytics API access token.
        required: false
        schema:
          type: string
      x-operation-id-source: normalized
      x-operation-id-original: Remove an Auth
  /api/auth/createtoken:
    post:
      responses:
        '201':
          description: Created
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthApiTokenModel'
              examples:
                response:
                  value:
                    status: success
                    data:
                      account_id: 4f7b525bdba058fc096757a6
                      id: 1b53b88a06b418b07d601b6f57b8eb40
                      provider_id: 26cae7718c32180a7a0f8e19d6d40a59
                      name: my-token-for-service-x
                      provider_name: Lytics
                      config:
                      - api_key: api_value
      security:
      - ApiKeyAuth: []
      summary: Auth Create Token
      operationId: AuthCreateToken
      description: Create Lytics api tokens.
      tags:
      - Auth
      parameters:
      - name: account_id
        in: query
        description: Your Lytics account ID.
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                expires:
                  type: string
                scopes:
                  type: array
                  items:
                    type: string
                name:
                  type: string
              example:
                expires: 100h
                scopes:
                - admin
                - data
                name: my-token-for-serivce-x
      x-operation-id-source: normalized
      x-operation-id-original: Auth Create Token
components:
  schemas:
    AuthModel:
      type: object
      properties:
        status:
          type: string
        data:
          type: object
          properties:
            account_id:
              type: string
            id:
              type: string
            provider_id:
              type: string
            provider_name:
              type: string
            user_id:
              type: string
      example:
        status: success
        data:
          account_id: 4f7b525bdba058fc096757a6
          id: 1b53b88a06b418b07d601b6f57b8eb40
          provider_id: 26cae7718c32180a7a0f8e19d6d40a59
          provider_name: Facebook
          user_id: 4222fd7c8db7ebcb042e0547e3b4e128
    AuthApiTokenModel:
      type: object
      properties:
        status:
          type: string
        data:
          type: object
          properties:
            account_id:
              type: string
            id:
              type: string
            provider_id:
              type: string
            name:
              type: string
            provider_name:
              type: string
            config:
              type: array
              items:
                type: object
                properties:
                  api_key:
                    type: string
      example:
        status: success
        data:
          account_id: 4f7b525bdba058fc096757a6
          id: 1b53b88a06b418b07d601b6f57b8eb40
          provider_id: 26cae7718c32180a7a0f8e19d6d40a59
          name: my-token-for-service-x
          provider_name: Lytics
          config:
          - api_key: api_value
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: Authorization
      type: apiKey
x-readme:
  explorer-enabled: true
  proxy-enabled: true