Skip to main content
POST
/
v1
/
accounts
/
search
Search accounts
curl --request POST \
  --url https://api.octolane.com/v1/accounts/search \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "query": "<string>",
  "q": "<string>",
  "filters": [
    {
      "field": "created_at",
      "operator": "gt",
      "value": "2024-06-11T01:40:00Z"
    }
  ],
  "sort": "<string>",
  "cursor": "<string>",
  "limit": 250,
  "fields": [
    "<string>"
  ]
}
'
{
  "success": true,
  "message": "<string>",
  "data": {
    "custom_field_definitions": {
      "last_action_date": {
        "current_name": "Last Action Date",
        "property_name": "custom__last_action_date",
        "attribute_type": "date",
        "metadata": null
      },
      "kola": {
        "current_name": "Kola",
        "property_name": "custom__kola",
        "attribute_type": "multi_select",
        "metadata": {
          "options": [
            {
              "label": "E",
              "value": "e-532837",
              "color": "indigo"
            }
          ]
        }
      }
    },
    "has_more": true,
    "next_cursor": "<string>",
    "limit": 123,
    "accounts": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "domain": "<string>",
        "custom_fields": {}
      }
    ]
  }
}

Authorizations

x-api-key
string
header
required

Public API key for the Octolane organization.

Body

application/json

Search body with optional text query, structured filters, sort, cursor pagination, and field projection.

query
string
q
string
filters
object[]
Maximum array length: 50
sort

Compact sort expression. Use field, field:asc, or field:desc.

Pattern: ^[^:]+(?::(asc|desc))?$
cursor
string | null
limit
integer
Required range: 1 <= x <= 500
fields
string[]
Maximum array length: 100

Response

Accounts were returned.

success
boolean
Example:

true

message
string
data
object

Endpoint-specific response payload.