Skip to main content
POST
/
companies
/
{company_id}
/
customers
/
find
Find Customers
curl --request POST \
  --url https://api.maplebilling.com/api/v1/companies/{company_id}/customers/find \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pagination": {
    "from_key": "<unknown>",
    "limit": 20
  },
  "include_meta": true,
  "query": {
    "arr": {
      "eq": "<unknown>",
      "gt": "<unknown>",
      "gte": "<unknown>",
      "lte": "<unknown>"
    },
    "email": "<unknown>",
    "exclude_from_metrics": "<unknown>",
    "has_parent": "<unknown>",
    "identifier": "<unknown>",
    "managed_externally": "<unknown>",
    "metadata": {
      "condition": "AND",
      "values": [
        "<string>"
      ]
    },
    "mrr": {
      "eq": "<unknown>",
      "gt": "<unknown>",
      "gte": "<unknown>",
      "lte": "<unknown>"
    },
    "name": "<unknown>",
    "org_name": "<unknown>",
    "owner_id": "<string>",
    "owner_ids": {
      "condition": "AND",
      "values": [
        "<string>"
      ]
    },
    "parent_customer_id": "<string>",
    "phone": "<unknown>",
    "search": "<unknown>",
    "status": "ACTIVE",
    "statuses": "ACTIVE",
    "tags": {
      "condition": "AND",
      "values": [
        "<string>"
      ]
    },
    "title": "<unknown>"
  },
  "sort_key": "createdAtDesc"
}
'
{
  "pagination": {
    "from_key": "<unknown>",
    "limit": 123
  },
  "results": [
    {
      "address": {
        "address_line_1": "<string>",
        "address_line_2": "<string>",
        "city": "<string>",
        "country": "<string>",
        "place_id": "<unknown>",
        "state": "<string>",
        "zip": "<string>"
      },
      "arr": {
        "currency": "<string>",
        "value_in_cents": 123
      },
      "billing_emails": [
        "<string>"
      ],
      "company_id": "<string>",
      "computed_entitlements": [
        {
          "entitlement_id": "<string>",
          "id": "<string>",
          "inherited_from_id": "<unknown>",
          "inherited_from_type": "<unknown>",
          "key": "<string>",
          "name": "<string>",
          "original_value": "<unknown>",
          "overridden": "<unknown>",
          "type": "<string>",
          "value": "<unknown>"
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "customer_integration_metadata": {},
      "email": "<string>",
      "exclude_from_metrics": true,
      "id": "<string>",
      "identifier": "<string>",
      "integration_references": [
        {
          "integration_icon": "<string>",
          "integration_id": "<string>",
          "integration_key": "<string>",
          "integration_name": "<string>",
          "reference_type": "<string>",
          "remote_id": "<string>",
          "remote_type": "<string>"
        }
      ],
      "locale": "<string>",
      "managed_externally": true,
      "metadata": {},
      "mrr": {
        "currency": "<string>",
        "value_in_cents": 123
      },
      "name": "<string>",
      "org_name": "<string>",
      "owner_id": "<unknown>",
      "parent_customer_id": "<unknown>",
      "phone": "<string>",
      "status": "<string>",
      "title": "<string>",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Idempotency-Key
string

The idempotency key that will be used to ensure the request is only performed once

Path Parameters

​
company_id
string
required

The company ID with the prefix 'cmp_'.

Body

application/json
​
pagination
object
required

The pagination parameters for the request

​
include_meta
boolean | null

Whether to include additional metadata in the pagination response such the number of total results

​
query
object

The query criteria for the request

​
sort_key
enum<string>
default:createdAtDesc
Available options:
createdAtDesc,
createdAtAsc,
updatedAtAsc,
updatedAtDesc,
aToZ,
zToA,
mrrAsc,
mrrDesc,
orgAToZ,
orgZToA

Response

200 - application/json

OK

​
pagination
object
​
results
object[] | null