Skip to Content

List businesses

GET
/v1/ec/businesses

With a key, its own business alone: a key acts for one. With a person's session, the organization's practice and live businesses, each with its kind.

Authorization

headerAuthorizationBearer <token>

Your API key, which acts for the one business it was created for: fb_live_… keys work at api.fiscalbase.io and issue in live, and fb_sandbox_… keys work at api-sandbox.fiscalbase.io and issue in sandbox, on the simulated SRI. A key sent to the other host is refused with api_key_wrong_host, which names its host.

Query Parameters

limit?integer

How many per page, from 1 to 100.

Range1 <= value <= 100
Default20
cursor?string

The next_cursor or prev_cursor of a previous response. Without a cursor, the first page.

Lengthlength <= 200
kind?string

Only the businesses of this kind: sandbox ones issue with a sandbox key, live ones with a test or live key. Without it, all of them.

Value in"sandbox""live"

Header Parameters

Fiscalbase-Environment?string

The environment the call acts in. Required with a person's session; a key's own environment is the one that counts, so a key may leave it out, and naming another is 422 environment_mismatch.

Value in"sandbox""test""live"
Fiscalbase-Business?string

The business the call acts for. With a person's session, the one the call is about (without it, a call about one business is 422 business_required and a list covers every business of the organization); a key acts for its own, so naming another is 422 business_mismatch.

Formatuuid
Fiscalbase-Channel?string

Which of Fiscalbase's own integrations a key's call comes from, recorded as the channel of the documents it issues: a record, not a permission. Without it, api. A person's call is always console.

Value in"api""mcp"
Fiscalbase-Agent?string

The AI agent a key's call comes from, as its client names itself (the MCP server sets it); recorded with the request and shown in the console's request log.

Response Body

The businesses

application/json
  1. response
object*"list"
Value in"list"
data*array<>
next_cursor*|

The next page (older); null if there are no more.

prev_cursor*|

The previous page (newer); null on the first.

Example Request
curl -X GET 'https://api.fiscalbase.io/v1/ec/businesses'
Example Response
{
  "object": "list",
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "object": "business",
      "kind": "sandbox",
      "country": "ec",
      "ruc": "string",
      "legal_name": "string",
      "trade_name": "string",
      "head_office_address": "string",
      "head_office_phone": "string",
      "head_office_email": "string",
      "reply_to_email": "string",
      "footer_legend": "string",
      "keeps_accounting": true,
      "regime": "general",
      "special_taxpayer_resolution": "string",
      "withholding_agent_resolution": "string",
      "large_taxpayer_resolution": "string",
      "certificate": {
        "holder": "string",
        "holder_identification": "string",
        "holder_identification_type": "cedula",
        "kind": "natural_person",
        "issuer_name": "string",
        "subject": "string",
        "issuer": "string",
        "serial_number": "string",
        "valid_from": "2019-08-24T14:15:22Z",
        "valid_until": "2019-08-24T14:15:22Z"
      },
      "issuing": {
        "allowed": true,
        "lock": {
          "code": "plan_required",
          "message": "string",
          "canceled": true,
          "trial_ended": true
        },
        "state": "off",
        "active_since": "2019-08-24T14:15:22Z"
      },
      "portal": {
        "brand_color": "string",
        "title_font": "sora",
        "corners": "square",
        "layout": "split",
        "cover": "brand",
        "cover_url": "http://example.com",
        "heading": "string",
        "lead": "string",
        "tagline": "string",
        "top_bar": "white",
        "whatsapp": "string",
        "website": "string"
      },
      "logo": {
        "url": "http://example.com",
        "content_type": "image/png",
        "size": 0
      },
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "next_cursor": "string",
  "prev_cursor": "string"
}