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

# Find Customers

> Search customers with given parameters



## OpenAPI

````yaml https://api.getmeasure.com/api/v1/docs/api_spec.json post /companies/{company_id}/customers/find
openapi: 3.1.0
info:
  title: Measure API
  description: APIs to communicate with Measure
  version: 1.0.0
servers:
  - url: https://api.getmeasure.com/api/v1
security: []
paths:
  /companies/{company_id}/customers/find:
    post:
      tags:
        - Customers
      summary: Find Customers
      description: Search customers with given parameters
      operationId: Find_Customers
      parameters:
        - name: company_id
          in: path
          description: 'The company ID with the prefix ''cmp_''. '
          required: true
          schema:
            description: 'The company ID with the prefix ''cmp_''. '
            type: string
        - name: Idempotency-Key
          in: header
          description: >-
            The idempotency key that will be used to ensure the request is only
            performed once
          schema:
            description: >-
              The idempotency key that will be used to ensure the request is
              only performed once
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestFindCustomerRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseFindCustomerLiteResponse'
      deprecated: false
      security:
        - apiKey:
            - ''
components:
  schemas:
    RequestFindCustomerRequest:
      properties:
        include_meta:
          description: >-
            Whether to include additional metadata in the pagination response
            such the number of total results
          type:
            - boolean
            - 'null'
        pagination:
          $ref: '#/components/schemas/RequestPaginationRequest'
          description: The pagination parameters for the request
        query:
          $ref: '#/components/schemas/RequestFindCustomerQueryCriteria'
          description: The query criteria for the request
        sort_key:
          default: createdAtDesc
          enum:
            - createdAtDesc
            - createdAtAsc
            - updatedAtAsc
            - updatedAtDesc
            - aToZ
            - zToA
            - mrrAsc
            - mrrDesc
            - orgAToZ
            - orgZToA
          type: string
      required:
        - pagination
      type: object
    ResponseFindCustomerLiteResponse:
      properties:
        pagination:
          $ref: '#/components/schemas/ResponsePaginationResponse'
        results:
          items:
            $ref: '#/components/schemas/ResponseCustomerLiteRepresentation'
          type:
            - array
            - 'null'
      type: object
    RequestPaginationRequest:
      description: The pagination parameters for the request
      properties:
        from_key:
          type:
            - 'null'
            - string
        limit:
          default: 20
          format: int64
          maximum: 200
          minimum: 0
          type: integer
      type: object
    RequestFindCustomerQueryCriteria:
      description: The find criteria for the customer
      properties:
        arr:
          $ref: '#/components/schemas/ModelAmountFilter'
          description: Filter based on ARR ranges
        email:
          description: The email of the customer
          type:
            - 'null'
            - string
        exclude_from_metrics:
          description: Whether the customer is excluded from metrics or not
          type:
            - 'null'
            - boolean
        has_parent:
          description: Whether this customer has a parent or not
          type:
            - 'null'
            - boolean
        identifier:
          description: The identifier of the customer that ties them back to your system
          type:
            - 'null'
            - string
        managed_externally:
          description: Whether the customer is managed customer outside of Measure
          type:
            - 'null'
            - boolean
        metadata:
          $ref: '#/components/schemas/ModelArrayFilterString'
          description: >-
            Filter based on metadata, each element must follow key:value format
            (e.g., juice:apple). The key is the metadata field and the value is
            the expected match; ArrayFilter condition determines how multiple
            filters are applied.
        mrr:
          $ref: '#/components/schemas/ModelAmountFilter'
          description: Filter based on MRR ranges
        name:
          description: The name of the customer
          type:
            - 'null'
            - string
        org_name:
          description: The org name of the customer
          type:
            - 'null'
            - string
        owner_id:
          description: >-
            The company user ID of the user in Measure that is assigned to
            manage this customer
          type:
            - string
            - 'null'
        owner_ids:
          $ref: '#/components/schemas/ModelArrayFilterString'
          description: >-
            The company user ID of the user in Measure that is assigned to
            manage this customer
        parent_customer_id:
          description: The parent customer ID of the customer
          type:
            - string
            - 'null'
        phone:
          description: The phone number of the customer
          type:
            - 'null'
            - string
        search:
          description: Any search string to match customers
          type:
            - 'null'
            - string
        status:
          description: >-
            The specific status of the customer that can be one of ACTIVE or
            ARCHIVED
          enum:
            - ACTIVE
            - ARCHIVED
          type:
            - 'null'
            - string
        statuses:
          description: The status of the customers that can include ACTIVE and ARCHIVED
          enum:
            - ACTIVE
            - ARCHIVED
          items:
            type: string
          type:
            - array
            - 'null'
        tags:
          $ref: '#/components/schemas/ModelArrayFilterString'
          description: The tags of the customer
        title:
          description: The title of the customer
          type:
            - 'null'
            - string
      type:
        - object
        - 'null'
    ResponsePaginationResponse:
      properties:
        from_key:
          type:
            - 'null'
            - string
        limit:
          format: int64
          type: integer
      type: object
    ResponseCustomerLiteRepresentation:
      properties:
        address:
          $ref: '#/components/schemas/ModelAddress'
          description: The address of the customer
        arr:
          $ref: '#/components/schemas/ModelAmount'
          description: The ARR of the customer
        billing_emails:
          description: The additional emails to cc on customer's invoices
          items:
            type: string
          type:
            - array
            - 'null'
        company_id:
          description: The company ID of the customer
          type: string
        computed_entitlements:
          description: The computed entitlements for the customer
          items:
            $ref: '#/components/schemas/ResponseEntitlementDataRepresentation'
          type:
            - array
            - 'null'
        created_at:
          description: The date the customer was created
          format: date-time
          type: string
        customer_integration_metadata:
          additionalProperties:
            $ref: '#/components/schemas/ModelCustomerIntegrationMetadata'
          type: object
        display_name:
          description: The computed display name of the customer
          type: string
        email:
          description: The email of the customer
          type: string
        exclude_from_metrics:
          description: >-
            Whether to exclude this customer and related fields from any metrics
            in Measure
          type: boolean
        id:
          description: The ID of the customer in Measure
          type: string
        identifier:
          description: >-
            The unique identifier for the customer that ties back to your
            system. You can query for a customer using this identifier
          type: string
        integration_references:
          description: >-
            The integration references of this customer in third-party
            applications connected to Measure
          items:
            $ref: '#/components/schemas/ResponseCustomerIntegrationRefs'
          type: array
        locale:
          description: The locale of the customer
          type: string
        managed_externally:
          description: Whether this customer is managed outside of Measure
          type: boolean
        metadata:
          additionalProperties: true
          description: The metadata as key-value pairs attached to this customer
          type: object
        mrr:
          $ref: '#/components/schemas/ModelAmount'
          description: The MRR of the customer
        name:
          description: The name of the customer
          type: string
        org_name:
          description: >-
            The name of the company or the organization this customer is a part
            of
          type: string
        owner_id:
          description: >-
            The company user ID of person in Measure assigned to manage this
            customer
          type:
            - 'null'
            - string
        parent_customer_id:
          description: The customer ID of the parent customer assigned in Measure
          type:
            - 'null'
            - string
        phone:
          description: The phone number of the customer
          type: string
        status:
          description: The status of the customer such as ACTIVE or ARCHIVED
          type: string
        title:
          description: The title of the customer, such as CEO, VP
          type: string
        updated_at:
          description: The date the customer was last updated
          format: date-time
          type: string
      type: object
    ModelAmountFilter:
      properties:
        eq:
          description: Equal to
          type:
            - 'null'
            - number
        gt:
          description: Greater than
          type:
            - 'null'
            - number
        gte:
          description: Greater than or equal to
          type:
            - 'null'
            - number
        lte:
          description: Less than or equal to
          type:
            - 'null'
            - number
      type:
        - object
        - 'null'
    ModelArrayFilterString:
      properties:
        condition:
          enum:
            - AND
            - OR
          type: string
        values:
          items:
            type: string
          type:
            - array
      required:
        - condition
        - values
      type: object
    ModelAddress:
      properties:
        address_line_1:
          type: string
        address_line_2:
          type: string
        city:
          type: string
        country:
          description: 2-character country code (ISO 3166-1 alpha-2)
          examples:
            - US
          type: string
        place_id:
          type:
            - 'null'
            - string
        state:
          type: string
        zip:
          type: string
      type: object
    ModelAmount:
      description: The amount which has value in cents and a currency
      properties:
        currency:
          type: string
        value_in_cents:
          format: int64
          type: integer
      type: object
    ResponseEntitlementDataRepresentation:
      properties:
        entitlement_id:
          type: string
        id:
          type: string
        inherited_from_id:
          type:
            - 'null'
            - string
        inherited_from_type:
          type:
            - 'null'
            - string
        key:
          type: string
        name:
          type: string
        original_value: {}
        overridden:
          type:
            - 'null'
            - boolean
        type:
          type: string
        value: {}
      type: object
    ModelCustomerIntegrationMetadata:
      properties:
        anrok:
          $ref: '#/components/schemas/ModelAnrokCustomerIntegrationMetadata'
        avalara:
          $ref: '#/components/schemas/ModelAvalaraCustomerIntegrationMetadata'
      type: object
    ResponseCustomerIntegrationRefs:
      properties:
        integration_icon:
          type: string
        integration_id:
          type: string
        integration_key:
          type: string
        integration_name:
          type: string
        reference_type:
          type: string
        remote_id:
          type: string
        remote_type:
          type: string
      type: object
    ModelAnrokCustomerIntegrationMetadata:
      properties:
        vat_id:
          type: string
      type: object
    ModelAvalaraCustomerIntegrationMetadata:
      properties:
        entity_code:
          type: string
      type: object
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer

````