Get an account

1 of 7 fields has no description in the spec.

• accountId#stringin pathrequired

• includeSites#booleanin query

  Include sites

• includeParentAccount#booleanin query

  Include parent account

• includeBillingInfo#booleanin query

  Include billing info

• includeFiscalInfo#booleanin query

  Include fiscal info

• includeMetrics#booleanin query

  Include metrics

  Required in the spec, optional for the API.

• includeDonorPlatform#booleanin query

  Include donor platform

  Required in the spec, optional for the API.

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"
  }

• 403Forbidden

  {
    "statusCode": 403,
    "message": "Forbidden"
  }

• 403Account closed

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

• 404Not Found

  No resource with this id on your account: the API answers as if it did not exist.

  {
    "statusCode": 404,
    "message": "Not Found"
  }