Skip to content
Aller au contenu
Charitips

API reference · Accounts

List accounts

GET/v1/accounts

No description in the spec yet.

Requires a Bearer access token.

Parameters

  • 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.

Response

200 · Account[]

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"
    }
GET /v1/accounts
curl -X GET https://api.sandbox.charitips.com/v1/accounts \  -H "Authorization: Bearer $CHARITIPS_TOKEN"
Built from the spec and the API code

Request bodies are written for this docs and checked against the API's validation; ids in angle brackets are placeholders. Response values are placeholders built from the schema.