SIsivo
Accounts

List all accounts

Changed on
get/accounts

Request

  • Base URL
    https://core.sivo.com
  • Auth
    • API key in header Authorization
    • or OAuth 2
      Authorization codehttps://dashboard.sivo.com/oauth/authorize
      Client credentials
      Token URLhttps://core.sivo.com/oauth/token
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Query parameters

limitinteger

Maximum number of results to return, from 1 to 100; defaults to 25

pagestring

Opaque page token from a previous response's next_page or previous_page; pass it back unchanged, with the same sort and filters

expandstring[]

Extra fields to include in the page; total_count counts the matching results, exactly up to 10000

sort'created_at_desc'

Result order; defaults to created_at_desc

namestring

Non-empty text string

type'business' | 'individual'

Legal entity type

metadataobject

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

Response

Successful operation

has_moreboolean required

Whether more results follow this page in the list order

next_pagestring nullable required

Token for the page after this one, or null when this is the last page

previous_pagestring nullable required

Token for the page before this one, or null when this is the first page

total_countinteger

Number of results matching the filters, exact up to 10000; 10001 means more than that. Only present when the request expands total_count

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": "acct-123",
      "created_at": "2024-01-15T10:30:00Z",
      "created_by": "user_0123456789ABCDEFGHIJKLMNOPq",
      "updated_at": "2024-01-15T10:30:00Z",
      "updated_by": "user_0123456789ABCDEFGHIJKLMNOPq"
    }
  ]
}

Changes

  • 4bbab9699612Revision changes
    • breaking

      added to the // response property oneOf list for the response status

    • breaking

      added to the // response property oneOf list for the response status

    • warning

      deleted the query request parameter id

    • warning

      deleted the query request parameter skip

    • warning

      deleted the query request parameter take

    • info

      added the new optional query request parameter expand

    • info

      added the new optional query request parameter limit

    • info

      added the new optional query request parameter page

    • info

      added the new optional query request parameter sort

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property to the response with the status

    • info

      the // response's property pattern was changed from ^[a-z]{3,7}_[0-9A-Za-z]{27}$ to ^[0-9A-Za-z_-]{1,255}$ for the status

    • info

      the // response's property pattern was changed from ^[a-z]{3,7}_[0-9A-Za-z]{27}$ to ^[0-9A-Za-z_-]{1,255}$ for the status

    • info

      the // response's property pattern ^[a-z]{3,7}_[0-9A-Za-z]{27}$ was removed for the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status