List child accounts

1 of 10 fields has no description in the spec.

• accountId#stringin pathrequired

• limit#numberin queryintegerminimum 1maximum 100

  The max number of items to return.

• cursor#stringin queryUUID

  The id of the last item from the previous page. Used to fetch the next page.

• includeUsers#booleanin query

  Include child accounts' users

• includeBillingInfo#booleanin query

  Include child accounts' billing info

• includeMetrics#booleanin query

  Include metrics

  Required in the spec, optional for the API.

• search#stringin queryat least 3 characters

  Full text search on the name field. Minimum length: 3

  Required in the spec, optional for the API.

• sort#stringin query

  Sorting field and order

  createdAt:asccreatedAt:descname:ascname:descmetrics.claimedDonationsVolume:ascmetrics.claimedDonationsVolume:descinvoices._count:ascinvoices._count:descfiscalReceipts._count:ascfiscalReceipts._count:desc

• includeInvoicesCount#booleanin query

  Include invoices count

  Required in the spec, optional for the API.

• includeFiscalReceiptsCount#booleanin query

  Include fiscal receipts count

No field is described in the spec.

• accountId#stringalways returned

• name#stringalways returned

• status#AccountStatusalways returned

  PENDINGVALIDATEDCLOSED

• type#AccountTypealways returned

  INDIVIDUALCOMPANY

• logoUrl#string

• faviconUrl#string

• titleColor#string

• accentColor#string

• headcount#string

• authSchemes#AuthScheme[]always returned

• parentAccountId#string

• linkedAccountId#string

• createdAt#string (date-time)always returned

• updatedAt#string (date-time)always returned

Errors

• 400A field is missing, has the wrong type, or is not part of the request schema.

  Every request with a body or query is validated.

  {
    "statusCode": 400,
    "message": [
      "amount must not be less than 1",
      "property foo should not exist"
    ],
    "error": "Bad Request"
  }

• 401Unauthorized

  Missing, expired or invalid access token.

  {
    "statusCode": 401,
    "message": "Unauthorized"
  }

• 403Account closed

  {
    "message": "Account closed",
    "code": "ACCOUNT_CLOSED"
  }