v1

latestOpenAPI 3.1.02026-07-247328324.6 KB

Accounts

List all accounts

get/accounts

Query parameters

skipinteger

For pagination, skip a number of results

Example:42

For pagination, skip a number of results

takeinteger

Only take up to a number of results.

Example:42

Only take up to a number of results.

idstring

A cursor (bookmark) used to only return results equal or lower than the given id. More efficient than skip for large result sets.

Example:user_0123456789ABCDEFGHIJKLMNOPq

A cursor (bookmark) used to only return results equal or lower than the given id. More efficient than skip for large result sets.

metadataobject

Metadata filters, use the following format to construct a clause for a metadata search: metadata["<field>"]:<value>

namestring

Non-empty text string

type'business' | 'individual'

Legal entity type

Response

Successful operation

Example response

{
  "data": [
    {
      "website": "https://acme.com",
      "email": "email@domain.com",
      "phone": "+14155551234",
      "industry": "541511",
      "legal_entity_id": "duns:123456789",
      "credit_score": "paydex:123",
      "active_since": "2024-01-15",
      "monthly_revenue": 10000,
      "monthly_costs": 10000,
      "cash_on_hand": 10000,
      "avg_sale_size": 10000,
      "buyer_concentration": 0.05,
      "average_days_to_pay": 42,
      "lifetime_spend": 10000,
      "customer_count": 42,
      "insurance": {
        "rating": "coface:8",
        "limit": 10000,
        "coverage": 0.05
      },
      "metadata": {
        "key": "value"
      },
      "id": "user_0123456789ABCDEFGHIJKLMNOPq",
      "created_at": "2024-01-15T10:30:00Z",
      "created_by": "user_0123456789ABCDEFGHIJKLMNOPq",
      "updated_at": "2024-01-15T10:30:00Z",
      "updated_by": "user_0123456789ABCDEFGHIJKLMNOPq"
    }
  ]
}