> ## 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.

# List Contacts

> Listing all the resolved contacts with pagination (Page size = 15). Resolved contacts are the ones with a value for identifier, email or phone number



## OpenAPI

````yaml /api-reference/openapi/EvoAI-CRM-Service/contacts.yaml get /api/v1/contacts
openapi: 3.0.4
info:
  title: Evolution Foundation - CRM Service - Contacts
  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/contacts:
    get:
      summary: List Contacts
      description: >-
        Listing all the resolved contacts with pagination (Page size = 15).
        Resolved contacts are the ones with a value for identifier, email or
        phone number
      operationId: contactList
      parameters:
        - $ref: '#/components/parameters/contact_sort_param'
      responses:
        '200':
          description: Contacts retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/extended_contact'
                    description: Array of contacts
                  meta:
                    type: object
                    properties:
                      pagination:
                        type: object
                        properties:
                          page:
                            type: integer
                            description: Current page number
                            example: 1
                          pageSize:
                            type: integer
                            description: Number of items per page
                            example: 20
                          total:
                            type: integer
                            description: Total number of contacts
                            example: 336
                          totalPages:
                            type: integer
                            description: Total number of pages
                            example: 17
                          hasNextPage:
                            type: boolean
                            description: Whether there is a next page
                            example: true
                          hasPreviousPage:
                            type: boolean
                            nullable: true
                            description: Whether there is a previous page
                            example: null
                      timestamp:
                        type: string
                        format: date-time
                        description: Response timestamp
                        example: '2026-01-29T17:22:49Z'
                  message:
                    type: string
                    description: Success message
                    example: Contacts retrieved successfully
              example:
                success: true
                data:
                  - id: 550e8400-e29b-41d4-a716-446655440000
                    name: John Doe
                    email: null
                    phone_number: '+5574999999999'
                    identifier: null
                    blocked: false
                    type: person
                    tax_id: null
                    website: null
                    industry: null
                    additional_attributes:
                      city: ''
                      country: ''
                      location:
                        city: ''
                        country: ''
                        country_code: ''
                      description: ''
                      company_name: ''
                      country_code: ''
                      social_profiles:
                        github: ''
                        twitter: ''
                        facebook: ''
                        linkedin: ''
                        instagram: ''
                    custom_attributes: {}
                    created_at: 1704067200
                    last_activity_at: null
                    labels: []
                    contact_inboxes: []
                  - id: 660e8400-e29b-41d4-a716-446655440001
                    name: Jane Smith
                    email: jane.smith@example.com
                    phone_number: null
                    identifier: null
                    blocked: false
                    type: person
                    tax_id: null
                    website: null
                    industry: null
                    additional_attributes:
                      source_id: email:example-source-id-123
                    custom_attributes: {}
                    created_at: 1704153600
                    last_activity_at: 1704153700
                    labels: []
                    contact_inboxes:
                      - source_id: jane.smith@example.com
                        inbox:
                          id: 770e8400-e29b-41d4-a716-446655440002
                          name: support-inbox
                          channel_type: Channel::Email
                meta:
                  pagination:
                    page: 1
                    pageSize: 20
                    total: 100
                    totalPages: 5
                    hasNextPage: true
                    hasPreviousPage: null
                  timestamp: '2024-01-15T10:30:00Z'
                message: Contacts retrieved successfully
        '400':
          description: Bad Request (invalid data)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                validation_error:
                  summary: Invalid request parameters
                  value:
                    success: false
                    error:
                      code: VALIDATION_ERROR
                      message: Invalid request parameters
                    meta:
                      timestamp: '2024-01-15T10:30:00Z'
                      path: /api/v1/contacts
                      method: GET
        '401':
          description: Unauthorized (invalid or missing token)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                invalid_token:
                  summary: Invalid or missing token
                  value:
                    success: false
                    error:
                      code: INVALID_TOKEN
                      message: Invalid token
                    meta:
                      timestamp: '2024-01-15T10:30:00Z'
                      path: /api/v1/contacts
                      method: GET
        '403':
          description: Forbidden (insufficient permissions)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                forbidden:
                  summary: Access forbidden
                  value:
                    success: false
                    error:
                      code: FORBIDDEN
                      message: You do not have permission to access this resource
                    meta:
                      timestamp: '2024-01-15T10:30:00Z'
                      path: /api/v1/contacts
                      method: GET
        '404':
          description: Not Found (resource not found)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                not_found:
                  summary: Resource not found
                  value:
                    success: false
                    error:
                      code: NOT_FOUND
                      message: Resource not found
                    meta:
                      timestamp: '2024-01-15T10:30:00Z'
                      path: /api/v1/contacts
                      method: GET
        '500':
          description: Internal Server Error (internal server error)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                internal_error:
                  summary: Internal server error
                  value:
                    success: false
                    error:
                      code: INTERNAL_ERROR
                      message: Internal server error
                    meta:
                      timestamp: '2024-01-15T10:30:00Z'
                      path: /api/v1/contacts
                      method: GET
      security:
        - userApiKey: []
components:
  parameters:
    contact_sort_param:
      name: sort
      in: query
      required: false
      description: Field for sorting results
      schema:
        type: string
        enum:
          - name
          - email
          - created_at
          - updated_at
      example: created_at
  schemas:
    extended_contact:
      allOf:
        - $ref: '#/components/schemas/contact_full'
        - type: object
          description: Extended contact with full details (alias for contact_full)
    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
    contact_full:
      type: object
      properties:
        id:
          type: string
          format: uuid
          example: 3b49511b-c35c-429c-85c3-a83feb87cbef
        name:
          type: string
          example: Maria Santos
        email:
          type: string
          nullable: true
          example: maria@empresa.com.br
        phone_number:
          type: string
          nullable: true
          example: '+5521987654321'
        identifier:
          type: string
          nullable: true
          example: DavidsonGomes
        blocked:
          type: boolean
          example: false
        type:
          type: string
          enum:
            - person
            - company
          example: person
        tax_id:
          type: string
          nullable: true
        website:
          type: string
          nullable: true
        industry:
          type: string
          nullable: true
        additional_attributes:
          type: object
          properties:
            city:
              type: string
            company:
              type: string
              example: Tech Solutions Ltda
            country:
              type: string
            location:
              type: object
              properties:
                city:
                  type: string
                country:
                  type: string
                country_code:
                  type: string
            description:
              type: string
            company_name:
              type: string
            country_code:
              type: string
            language_code:
              type: string
              example: pt-br
            username:
              type: string
            social_profiles:
              type: object
              properties:
                github:
                  type: string
                twitter:
                  type: string
                facebook:
                  type: string
                linkedin:
                  type: string
                instagram:
                  type: string
            social_telegram_user_id:
              type: integer
            social_telegram_user_name:
              type: string
        custom_attributes:
          type: object
          additionalProperties: true
        created_at:
          type: integer
          description: Unix timestamp
          example: 1765200698
        last_activity_at:
          type: integer
          nullable: true
          description: Unix timestamp of last activity
          example: 1768597854
        labels:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uuid
              title:
                type: string
              color:
                type: string
        contact_inboxes:
          type: array
          items:
            type: object
            properties:
              source_id:
                type: string
              inbox:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                  name:
                    type: string
                  channel_type:
                    type: string
  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.