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

# Get available contacts

> Get contacts that can be added to this pipeline as leads



## OpenAPI

````yaml /api-reference/openapi/EvoAI-CRM-Service/pipeline-items.yaml get /api/v1/pipelines/{pipeline_id}/pipeline_items/available_contacts
openapi: 3.0.4
info:
  title: Evolution Foundation - CRM Service - Pipeline Items
  description: Management of contacts, conversations, inboxes, labels and macros
  version: 1.1.0
servers:
  - url: https://api.evoai.app
    description: Production server
  - url: http://localhost:3000
    description: Development server
    variables:
      port:
        default: '3000'
  - url: '{customUrl}'
    description: Custom server
    variables:
      customUrl:
        default: https://your-instance.com
        description: Enter your server URL
security: []
paths:
  /api/v1/pipelines/{pipeline_id}/pipeline_items/available_contacts:
    parameters:
      - name: pipeline_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: search
        in: query
        required: false
        schema:
          type: string
    get:
      summary: Get available contacts
      description: Get contacts that can be added to this pipeline as leads
      operationId: get-available-contacts
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                  - meta
                  - message
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/contact'
                  meta:
                    type: object
                    properties:
                      timestamp:
                        type: string
                        format: date-time
                        description: Response timestamp
                        example: '2024-01-15T10:30:00Z'
                  message:
                    type: string
                    example: Available contacts retrieved successfully
              examples:
                success:
                  value:
                    success: true
                    data: []
                    meta:
                      timestamp: '2024-01-15T10:30:00Z'
                    message: Available contacts retrieved successfully
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                success: false
                error:
                  code: BAD_REQUEST
                  message: Invalid pipeline ID format
                meta:
                  timestamp: '2024-01-15T10:30:00Z'
                  path: >-
                    /api/v1/pipelines/{pipeline_id}/pipeline_items/available_contacts
                  method: GET
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                success: false
                error:
                  code: UNAUTHORIZED
                  message: Invalid or missing authentication token
                meta:
                  timestamp: '2024-01-15T10:30:00Z'
                  path: >-
                    /api/v1/pipelines/{pipeline_id}/pipeline_items/available_contacts
                  method: GET
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                success: false
                error:
                  code: FORBIDDEN
                  message: You do not have permission to access this pipeline
                meta:
                  timestamp: '2024-01-15T10:30:00Z'
                  path: >-
                    /api/v1/pipelines/{pipeline_id}/pipeline_items/available_contacts
                  method: GET
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                success: false
                error:
                  code: NOT_FOUND
                  message: Pipeline not found
                meta:
                  timestamp: '2024-01-15T10:30:00Z'
                  path: >-
                    /api/v1/pipelines/{pipeline_id}/pipeline_items/available_contacts
                  method: GET
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                success: false
                error:
                  code: INTERNAL_SERVER_ERROR
                  message: An unexpected error occurred
                meta:
                  timestamp: '2024-01-15T10:30:00Z'
                  path: >-
                    /api/v1/pipelines/{pipeline_id}/pipeline_items/available_contacts
                  method: GET
      security:
        - userApiKey: []
components:
  schemas:
    contact:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        email:
          type: string
          nullable: true
        phone_number:
          type: string
          nullable: true
        account_id:
          type: string
          format: uuid
        custom_attributes:
          type: object
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    ErrorResponse:
      type: object
      required:
        - success
        - error
        - meta
      properties:
        success:
          type: boolean
          example: false
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              example: VALIDATION_ERROR
            message:
              type: string
              example: Validation failed
            details:
              type: object
              additionalProperties: true
              nullable: true
        meta:
          type: object
          required:
            - timestamp
            - path
            - method
          properties:
            timestamp:
              type: string
              format: date-time
              example: '2024-01-15T10:30:00Z'
            path:
              type: string
              example: /public/api/v1/inboxes/{inbox_identifier}/contacts
            method:
              type: string
              example: POST
  securitySchemes:
    userApiKey:
      type: apiKey
      in: header
      name: api_access_token

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.