Skip to content
Aller au contenu
Charitips

API reference · Donors

Get a donor

GET/v1/donors/{donorId}

Retrieve information about a donor.

Requires a Bearer access token.

Parameters

This field has no description in the spec.

  • donorId#stringin pathrequired

Response

200 · Donor

No field is described in the spec.

  • donorId#stringalways returned

  • scopeType#DonorScopeTypealways returned

    CAMPAIGNACCOUNT

  • platformAccessStatus#DonorPlatformAccessStatusalways returned

    ENABLEDDISABLEDRESTRICTED

  • firstName#stringalways returned

  • lastName#stringalways returned

  • email#string

  • companyName#string

  • phone#string

  • extraInfo#string

  • birthdate#string (date-time)

  • street#string

  • streetAddition#string

  • city#string

  • country#string

  • zip#string

  • externalId#string

  • uniqueExternalId#string

  • slackId#string

  • pictureUrl#string

  • title#string

  • personalEmail#string

  • persona#Persona

    CSRMARKETINGHRSALESCOMMUNICATIONPRODUCTSMBOTHER

  • language#Language

    fren

  • hasAcceptedTerms#booleanalways returned

  • accountId#stringalways returned

  • campaignId#string

  • individualAccountId#string

  • createdAt#string (date-time)always returned

  • updatedAt#string (date-time)always returned

Errors

  • 401Unauthorized

    Missing, expired or invalid access token.

    {
      "statusCode": 401,
      "message": "Unauthorized"
    }
  • 403Account closed
    {
      "message": "Account closed",
      "code": "ACCOUNT_CLOSED"
    }
  • 404Not Found
    {
      "statusCode": 404,
      "message": "Not Found"
    }
GET /v1/donors/<donorId>
curl -X GET https://api.sandbox.charitips.com/v1/donors/<donorId> \  -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.