> ## Documentation Index
> Fetch the complete documentation index at: https://docs.api.tamtam.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get a companies list

> Get a companies list by ID, including the LinkedIn company IDs it currently contains. Customer API keys read from their own bound account (the `account_id` query param is ignored); staff TAMTAM API keys must supply an explicit `account_id`.



## OpenAPI

````yaml /reference/openapi.yaml get /v2/companies-lists/{listID}
openapi: 3.1.0
info:
  title: Tamtam Public API
  version: 2.0.0
servers:
  - url: https://api.tamtam.ai/api
security: []
paths:
  /v2/companies-lists/{listID}:
    get:
      tags:
        - Companies Lists
      summary: Get a companies list
      description: >-
        Get a companies list by ID, including the LinkedIn company IDs it
        currently contains. Customer API keys read from their own bound account
        (the `account_id` query param is ignored); staff TAMTAM API keys must
        supply an explicit `account_id`.
      operationId: get-companies-list
      parameters:
        - description: Companies list UUID
          in: path
          name: listID
          required: true
          schema:
            description: Companies list UUID
            examples:
              - b3c6f5e2-1234-4abc-9def-0123456789ab
            type: string
        - description: Target account UUID. Required for staff; ignored for customer keys.
          explode: false
          in: query
          name: account_id
          schema:
            description: >-
              Target account UUID. Required for staff; ignored for customer
              keys.
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompaniesListDto'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Error
      security:
        - apikeyAuth: []
        - bearerAuth: []
components:
  schemas:
    CompaniesListDto:
      additionalProperties: false
      properties:
        account_id:
          description: Owning account UUID
          type: string
        assignee:
          description: Email of the assigned owner
          type: string
        companies_count:
          description: Number of companies currently in the list
          format: int64
          type: integer
        company_linkedin_ids:
          description: LinkedIn company IDs currently in the list
          items:
            type: string
          type:
            - array
            - 'null'
        created_at:
          description: Creation timestamp
          format: date-time
          type: string
        created_by_user_email:
          description: Email of the creator
          type: string
        id:
          description: Companies list UUID
          type: string
        name:
          description: List name
          type: string
        tags:
          description: User-side organizational tags
          items:
            type: string
          type:
            - array
            - 'null'
      required:
        - company_linkedin_ids
        - id
        - account_id
        - name
        - tags
        - created_at
        - companies_count
      type: object
    ErrorModel:
      additionalProperties: false
      properties:
        detail:
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          examples:
            - Property foo is required but is missing.
          type: string
        errors:
          description: Optional list of individual error details
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
            - array
            - 'null'
        instance:
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem.
          examples:
            - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: HTTP status code
          examples:
            - 400
          format: int64
          type: integer
        title:
          description: >-
            A short, human-readable summary of the problem type. This value
            should not change between occurrences of the error.
          examples:
            - Bad Request
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          examples:
            - https://example.com/errors/example
          format: uri
          type: string
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: >-
            Where the error occurred, e.g. 'body.items[3].tags' or
            'path.thing-id'
          type: string
        message:
          description: Error message text
          type: string
        value:
          description: The value at the given location
      type: object
  securitySchemes:
    apikeyAuth:
      description: Account API key passed in the Authorization header
      in: header
      name: Authorization
      type: apiKey
    bearerAuth:
      description: Bearer JWT obtained via the OAuth 2.1 authorization flow
      scheme: bearer
      type: http

````