LLM Pulse Team API

The account team: list members and pending invitations, invite someone by email with their projects and access, revoke an invitation or remove a member, with the same rules as the Team Members settings page. Not available to a key limited to some projects.

GitHub OpenAPI

Operations 5

GET /team_members List team members #
GET /team_invitations List pending team invitations #
POST /team_invitations Invite a team member #
DELETE /team_invitations/{id} Revoke a pending team invitation #
DELETE /team_members/{id} Remove a team member #

Specifications

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/llmpulse-ai:llmpulse-ai-team-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

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. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

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

OpenAPI Specification

llmpulse-ai-team-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: LLM Pulse Team API
  description: 'REST API for the LLM Pulse AI visibility platform. Track brand mentions, citations, sentiment, and Share of Voice across AI-generated answers (ChatGPT, Perplexity, Gemini, Google AI Overviews, Google AI Mode, and optional add-on models). Includes the MCP (Model Context Protocol) endpoint for AI clients. MCP is available on every plan and during eligible trials via OAuth 2.1, with Bearer-token API keys also accepted for headless integrations on the Scale plan or above. Full machine-readable reference at https://llmpulse.ai/api-docs/llms-full.txt. An API key can be limited to one or several projects when it is created, and the set never changes. Such a key sees only those projects: any other project id, domain or name answers ERR_PROJECT_NOT_FOUND exactly like a project that does not exist, listings return only those projects'' rows, and operations on the whole account (creating or deleting a project, the project draft wizard) answer ERR_KEY_PROJECT_SCOPED. Operations carry vendor extensions: x-plan is the plan or entitlement the endpoint requires beyond an API key (growth, scale or reputation_access), x-write marks endpoints that need a read and write key, x-mcp-tool names the MCP tool that returns the same data, x-mcp-plan gives that tool''s plan where it differs, and x-rest-only explains an endpoint with no MCP tool. Parameters are read strictly, on REST and MCP alike: a value outside a documented enum, a boolean other than true, false, 1 or 0, an id or count that is not a plain positive number (12abc, 1.0 or 0), an id of a record the project does not have, or a from later than to answers 422 ERR_INVALID_PARAM naming the parameter, never an ignored filter. A listed value, in a query or a request body, matches in any letter case and is read in its documented spelling (granularity=Week reads as week, aggregation_type=BYPAGE as byPage, event_type=Mention.Created as mention.created). page and per_page keep their own rule: a value that is not a number reads as absent and an out-of-range one is clamped.'
  version: 1.97.0
  contact:
    name: LLM Pulse Support
    url: https://llmpulse.ai
    email: info@llmpulse.ai
  license:
    name: Proprietary
    url: https://llmpulse.ai/terms
servers:
- url: https://api.llmpulse.ai/api/v1
  description: Production API
security:
- BearerAuth: []
tags:
- name: Team
  description: 'The account team: list members and pending invitations, invite someone by email with their projects and access, revoke an invitation or remove a member, with the same rules as the Team Members settings page. Not available to a key limited to some projects.'
paths:
  /team_members:
    get:
      tags:
      - Team
      summary: List team members
      x-llms-description: The account team, owner first, with each member's access level, project access, status and last sign-in.
      operationId: listTeamMembers
      x-mcp-tool: list_team_members
      description: 'Lists the account owner first, then every team member who joined, with their access level (permission_role, account role and the resulting permissions), co-owner and billing flags, project access, status (active or blocked) and last sign-in. Pending invitations are listed by GET /team_invitations; GET /account limits.team_members.used counts both. Available to the account owner, co-owners and team members with the Team Members permission. A key limited to some projects answers ERR_KEY_PROJECT_SCOPED: the team belongs to the whole account.'
      parameters:
      - name: page
        in: query
        required: false
        schema:
          type: integer
      - name: per_page
        in: query
        required: false
        schema:
          type: integer
        description: Default 20, max 100
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  page:
                    type: integer
                  per_page:
                    type: integer
                  total:
                    type: integer
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/TeamMember'
                  request_id:
                    type: string
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/TeamForbidden'
  /team_invitations:
    get:
      tags:
      - Team
      summary: List pending team invitations
      x-llms-description: Pending team invitations with the access they grant, when they were sent and when they expire.
      operationId: listTeamInvitations
      x-mcp-tool: list_team_invitations
      description: 'Lists invitations that have not been accepted yet: the address, the access and projects the person will get, when the invitation was sent and when its link expires. An accepted invitation keeps its id and moves to GET /team_members. Same access rules as GET /team_members.'
      parameters:
      - name: page
        in: query
        required: false
        schema:
          type: integer
      - name: per_page
        in: query
        required: false
        schema:
          type: integer
        description: Default 20, max 100
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  page:
                    type: integer
                  per_page:
                    type: integer
                  total:
                    type: integer
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/TeamInvitation'
                  request_id:
                    type: string
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/TeamForbidden'
    post:
      tags:
      - Team
      summary: Invite a team member
      x-llms-description: Invite someone to the team by email, choosing their projects and access; they receive the invitation email.
      operationId: createTeamInvitation
      x-mcp-tool: invite_team_member
      x-write: true
      description: 'Invites someone to the account team with the same rules as the Team Members settings page, and sends them the invitation email (email_sent is false when the email provider refused it; the invitation still exists, so revoke it and invite again once the address is fixed). Send project_ids, or all_projects: true for every project (for a team member inviting, every project they can access). The account owner and co-owners choose the access with permission_role: full_access (default), view_only, custom (with permissions, feature key to verbs) or account_role (with account_role_id). A team member with permission to invite cannot choose access: leave those fields out and the invitation copies their own permissions. Only the account owner can set account_admin (co-owner) or billing_access. An address already registered on the platform, or with an invitation pending, is refused with ERR_INVALID_PARAM (revoke the pending one first). An account that cannot add more team members, or that reached its daily limit of invitations sent through the API and MCP (revoked ones count), answers ERR_LIMIT_REACHED; the message says which. Requires a `read_write` scope API key.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - email
              properties:
                email:
                  type: string
                project_ids:
                  type: array
                  items:
                    type: integer
                  description: Projects the member can access. Send this or all_projects true.
                all_projects:
                  type: boolean
                  description: Access to every project, including future ones
                permission_role:
                  type: string
                  enum:
                  - full_access
                  - view_only
                  - custom
                  - account_role
                  description: Default full_access. Owner and co-owners only.
                account_role_id:
                  type: integer
                  description: One of the account's roles, with permission_role account_role
                permissions:
                  type: object
                  additionalProperties:
                    type: array
                    items:
                      type: string
                  description: 'With permission_role custom: feature key to the verbs granted (read, create, update, delete), for example {"overview": ["read"], "prompts": ["read", "create"]}'
                account_admin:
                  type: boolean
                  description: Make the member a co-owner. Account owner only.
                billing_access:
                  type: boolean
                  description: Access to Billing and Plans. Account owner only.
      responses:
        '201':
          description: Created. The invitation, as GET /team_invitations lists it, and whether the email went out.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/TeamInvitation'
                - type: object
                  required:
                  - email_sent
                  properties:
                    email_sent:
                      type: boolean
                      description: False when the email provider refused the invitation email
                    request_id:
                      type: string
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/TeamForbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
  /team_invitations/{id}:
    delete:
      tags:
      - Team
      summary: Revoke a pending team invitation
      x-llms-description: Revoke a pending team invitation; its link stops working immediately.
      operationId: revokeTeamInvitation
      x-mcp-tool: revoke_team_invitation
      x-write: true
      description: 'Revokes a pending invitation: its link stops working immediately. Account owner or co-owner only, and a co-owner cannot revoke an invitation that makes someone a co-owner. Members who already joined are removed with DELETE /team_members/{id}; an id that is not a pending invitation of the account answers ERR_NOT_FOUND. Requires a `read_write` scope API key.'
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
        description: The invitation id from GET /team_invitations
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  revoked:
                    type: boolean
                  id:
                    type: integer
                  request_id:
                    type: string
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/TeamForbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /team_members/{id}:
    delete:
      tags:
      - Team
      summary: Remove a team member
      x-llms-description: Remove a team member; their sessions and API keys stop working at once and the account is deleted shortly after.
      operationId: removeTeamMember
      x-mcp-tool: remove_team_member
      x-write: true
      description: 'Removes a member from the team, as the settings page does: their sessions and API keys stop working at once and their user account is deleted in the background shortly after. Account owner or co-owner only; a co-owner cannot remove the owner, another co-owner or themselves. The owner cannot be removed. Pending invitations are revoked with DELETE /team_invitations/{id}; an id that is not a member of the account answers ERR_NOT_FOUND. Requires a `read_write` scope API key.'
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
        description: The member id from GET /team_members
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  removed:
                    type: boolean
                  id:
                    type: integer
                  request_id:
                    type: string
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/TeamForbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    TeamPermissions:
      type:
      - object
      - 'null'
      description: What the person can do, feature key to the verbs granted (read, create, update, delete), resolved from their role. Null for the account owner, who can do everything.
      additionalProperties:
        type: array
        items:
          type: string
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
              - ERR_MISSING_AUTH
              - ERR_INVALID_API_KEY
              - ERR_REVOKED_API_KEY
              - ERR_INSUFFICIENT_SCOPE
              - ERR_INSUFFICIENT_PERMISSION
              - ERR_KEY_PROJECT_SCOPED
              - ERR_PLAN_REQUIRED
              - ERR_INTEGRATION_UNAVAILABLE
              - ERR_GENERATION_FAILED
              - ERR_ACCOUNT_INACTIVE
              - ERR_DRAFT_NOT_FOUND
              - ERR_DRAFT_STATE
              - ERR_PROJECT_NOT_FOUND
              - ERR_NOT_FOUND
              - ERR_SEARCH_CONSOLE_NOT_CONNECTED
              - ERR_SEARCH_CONSOLE_ACCESS_REVOKED
              - ERR_SEARCH_CONSOLE_UPSTREAM
              - ERR_CMS_NOT_CONNECTED
              - ERR_CMS_ACCESS_REVOKED
              - ERR_CMS_REJECTED
              - ERR_CMS_UPSTREAM
              - ERR_AI_TRAFFIC_NOT_CONNECTED
              - ERR_WEB_ANALYTICS_NOT_CONNECTED
              - ERR_WEB_ANALYTICS_INVALID_QUERY
              - ERR_WEB_ANALYTICS_ACCESS_REVOKED
              - ERR_WEB_ANALYTICS_UPSTREAM
              - ERR_AGENT_TRAFFIC_NOT_CONNECTED
              - ERR_INVALID_PARAM
              - ERR_INVALID_RANGE
              - ERR_LIMIT_REACHED
              - ERR_QUOTA_EXCEEDED
              - ERR_STALE_CONTENT
              - ERR_RATE_LIMITED
            message:
              type: string
            meta:
              type: object
              description: Extra detail for some codes. A not-connected or access-revoked error from the Search Console, AI traffic, web analytics or agent traffic endpoints carries connect_url, the in-app page where the user connects or reconnects the source. A prompt write refused because a launched pitch project's prompts are fixed carries reason pitch_prompts_frozen.
        request_id:
          type: string
    TeamAccountRole:
      type:
      - object
      - 'null'
      description: The account role the person follows, when permission_role is account_role; null otherwise.
      required:
      - id
      - name
      properties:
        id:
          type: integer
        name:
          type: string
    TeamInvitation:
      type: object
      required:
      - id
      - email
      - permission_role
      - account_role
      - permissions
      - account_admin
      - billing_access
      - all_projects
      - project_ids
      properties:
        id:
          type: integer
          description: Kept by the member once they accept, when they move to GET /team_members.
        email:
          type: string
        permission_role:
          type: string
          enum:
          - full_access
          - view_only
          - custom
          - account_role
        account_role:
          $ref: '#/components/schemas/TeamAccountRole'
        permissions:
          $ref: '#/components/schemas/TeamPermissions'
        account_admin:
          type: boolean
        billing_access:
          type: boolean
        all_projects:
          type: boolean
        project_ids:
          type: array
          items:
            type: integer
        invited_at:
          type:
          - string
          - 'null'
          format: date-time
          description: When the invitation email was last sent.
        expires_at:
          type:
          - string
          - 'null'
          format: date-time
          description: When the invitation link stops working.
        created_at:
          type: string
          format: date-time
    TeamMember:
      type: object
      required:
      - id
      - email
      - role
      - status
      - permission_role
      - account_role
      - permissions
      - account_admin
      - billing_access
      - all_projects
      - project_ids
      properties:
        id:
          type: integer
        email:
          type: string
        name:
          type:
          - string
          - 'null'
        role:
          type: string
          enum:
          - owner
          - member
          description: The account owner is listed first; everyone else who joined is a member.
        status:
          type: string
          enum:
          - active
          - blocked
          description: A blocked member cannot sign in or use the API until unblocked in the app.
        permission_role:
          type:
          - string
          - 'null'
          description: 'Access level of a member: full_access, view_only, custom or account_role. Null for the owner.'
        account_role:
          $ref: '#/components/schemas/TeamAccountRole'
        permissions:
          $ref: '#/components/schemas/TeamPermissions'
        account_admin:
          type: boolean
          description: A co-owner, who can manage the team.
        billing_access:
          type: boolean
          description: Can open Billing and Plans (always true for the owner).
        all_projects:
          type: boolean
          description: Has access to every project of the account, including future ones.
        project_ids:
          type: array
          items:
            type: integer
          description: The projects a member is limited to; empty when all_projects is true.
        last_sign_in_at:
          type:
          - string
          - 'null'
          format: date-time
        joined_at:
          type:
          - string
          - 'null'
          format: date-time
          description: When the member accepted the invitation; null for the owner and for members added without one.
        created_at:
          type: string
          format: date-time
  responses:
    UnprocessableEntity:
      description: Invalid parameters
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: ERR_INVALID_PARAM
              message: invalid metrics
            request_id: abc-123
    TeamForbidden:
      description: A key limited to some projects answers ERR_KEY_PROJECT_SCOPED, since the team belongs to the whole account. A team member without the Team Members permission, or asking for something only the owner or a co-owner can do, answers ERR_INSUFFICIENT_PERMISSION, and a write with a read-only key ERR_INSUFFICIENT_SCOPE, with the same status
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: ERR_INSUFFICIENT_PERMISSION
              message: insufficient_team_member_permission
            request_id: abc-123
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: ERR_PROJECT_NOT_FOUND
              message: project_not_found
            request_id: abc-123
    Unauthorized:
      description: Authentication failed
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: ERR_MISSING_AUTH
              message: missing_authorization
            request_id: abc-123
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: API key authentication. Keys are managed at https://llmpulse.ai/app/api_keys (Scale plan or above). Used for the REST API and as a headless option for /mcp. A key can be limited to one or several projects when it is created; the set cannot be changed later.
    OAuth2:
      type: oauth2
      description: OAuth 2.1 with PKCE-S256 and Dynamic Client Registration. Accepted on /mcp only, available on every plan and during eligible trials. Discovery metadata at /.well-known/oauth-authorization-server.
      flows:
        authorizationCode:
          authorizationUrl: https://api.llmpulse.ai/oauth/authorize
          tokenUrl: https://api.llmpulse.ai/oauth/token
          scopes:
            mcp:read: Read data via MCP tools
            mcp:write: Create resources via MCP write tools