> ## Documentation Index
> Fetch the complete documentation index at: https://help.withallo.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Me

> Returns information about the authenticated API key: its scopes, available endpoints, team, and rate limits. No specific scope is required — any valid API key can call this endpoint.

Agents should call this endpoint first to discover their capabilities before making other API calls.



## OpenAPI

````yaml GET /v2/api/me
openapi: 3.0.3
info:
  title: Allo API
  description: >-
    Allo API provides programmatic access to your Allo account, allowing you to
    manage webhooks, retrieve calls and contacts, and send SMS messages.


    All requests to `/v1/api/**` endpoints automatically go through quota
    checking and scope validation.
  version: 1.0.0
  contact:
    name: Allo Support
servers:
  - url: https://api.withallo.com
    description: Production server
security: []
tags:
  - name: Summary Templates
    description: >-
      Manage call summary templates that control how AI-generated call summaries
      are structured for your team.
  - name: Webhooks
    description: >-
      Manage webhook endpoints to receive real-time notifications about events
      in your Allo account. Each endpoint subscribes to one or more event topics
      and is verified with a signing secret.
  - name: Calls
    description: >-
      Retrieve and search call records with filtering and pagination. Filter
      calls by your Allo phone number.
  - name: Contacts
    description: >-
      Search and retrieve contact information with sorting and pagination.
      Includes engagement level tracking.
  - name: SMS
    description: Send SMS messages to phone numbers using your Allo numbers.
  - name: Phone Numbers
    description: Retrieve information about your Allo phone numbers.
  - name: Analytics
    description: Pre-computed call metrics, team performance, and outbound dial funnel
  - name: CRM
    description: Manage people, companies, and deals in your CRM.
paths:
  /v2/api/me:
    get:
      tags:
        - Users
      summary: Me
      description: >-
        Returns information about the authenticated API key: its scopes,
        available endpoints, team, and rate limits. No specific scope is
        required — any valid API key can call this endpoint.


        Agents should call this endpoint first to discover their capabilities
        before making other API calls.
      operationId: getMe
      responses:
        '200':
          description: API key info retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/MeResponse'
              example:
                data:
                  api_key_id: api-abc123def456
                  scopes:
                    - CONVERSATIONS_READ
                    - PHONE_NUMBERS_READ
                    - TAGS_READ
                    - TAGS_WRITE
                    - USERS_READ
                  endpoints:
                    - method: GET
                      path: /v2/api/conversations
                      description: List conversations grouped by contact number
                      scope: CONVERSATIONS_READ
                    - method: POST
                      path: /v2/api/conversations/items/search
                      description: Search calls and SMS with filters and keyword search
                      scope: CONVERSATIONS_READ
                    - method: GET
                      path: /v2/api/tags
                      description: List all available tags
                      scope: TAGS_READ
                    - method: GET
                      path: /v2/api/users
                      description: List team members with roles and assigned numbers
                      scope: USERS_READ
                    - method: GET
                      path: /v2/api/numbers
                      description: List phone numbers with capabilities and member access
                      scope: PHONE_NUMBERS_READ
                  team:
                    id: team-xyz789
                    name: Acme Sales
                  rate_limits:
                    read_per_second: 20
                    write_per_second: 5
        '401':
          description: Invalid or missing API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    MeResponse:
      type: object
      description: Information about the authenticated API key and its capabilities
      properties:
        api_key_id:
          type: string
          description: Unique identifier of this API key
        scopes:
          type: array
          description: >-
            Scopes granted to this key. Determines which endpoints appear in the
            endpoints list
          items:
            type: string
        endpoints:
          type: array
          description: Endpoints this key can call, filtered by granted scopes
          items:
            type: object
            properties:
              method:
                type: string
                description: HTTP method
                enum:
                  - GET
                  - POST
                  - PUT
                  - DELETE
              path:
                type: string
                description: Endpoint path with parameter placeholders
              description:
                type: string
                description: What the endpoint does
              scope:
                type: string
                description: The scope that grants access to this endpoint
        team:
          type: object
          nullable: true
          description: The team this key belongs to. Null if the user has no team
          properties:
            id:
              type: string
            name:
              type: string
        rate_limits:
          type: object
          description: Request rate limits for this API key
          properties:
            read_per_second:
              type: integer
              description: Maximum GET requests per second
            write_per_second:
              type: integer
              description: Maximum POST/PUT/DELETE requests per second
    ApiError:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
            code:
              type: string
            message:
              type: string
            retryable:
              type: boolean
            request_id:
              type: string
            retry_after_seconds:
              type: integer
              nullable: true
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization

````