v1

latestOpenAPI 3.0.12026-07-26222700728.0 KB

Company Management

Query companies

Query companies for the authenticated user

post/v6/company/query

Request body

cursorstring nullable

Cursor from the previous paginated response

limitinteger

Page size, i.e. number of items to return per page

Example request

{
  "filter": {
    "entityType": {
      "in": [
        "LLC",
        "S_CORP"
      ],
      "notIn": [
        "SOLE_PROPRIETORSHIP"
      ]
    },
    "businessType": {
      "id": {
        "in": [
          "bzt_123456",
          "bzt_789012"
        ],
        "notIn": [
          "bzt_999999"
        ]
      }
    }
  }
}

Response

Success

result'SUCCESS' | 'FAILURE'

The result of the action performed.

Example response

{
  "data": [
    {
      "id": "co_235823",
      "name": "ACME Corp",
      "apiCompanyId": "fake_company_123",
      "owners": [
        {
          "userId": "fake_userId",
          "email": "joe@tight.com",
          "firstName": "Joe",
          "lastName": "Perkins",
          "language": "EN"
        }
      ],
      "address": {
        "countryCode": "USA"
      },
      "accountingMethod": "ACCRUAL",
      "businessType": {
        "id": "bzt_123456",
        "name": "Electrician"
      },
      "availableFeatures": {
        "bankTransactions": true,
        "bills": true,
        "bookkeeping": true,
        "imports": true,
        "invoicing": true,
        "payroll": true,
        "reporting": true,
        "taxes": true,
        "timeTracking": true,
        "mileage": true
      },
      "status": "ACTIVE"
    }
  ]
}