List donors

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

• externalId#stringin query

  An optional internal id of your system e.g orderId or customerId. Can be used to link a donor to an entity in your system.

• uniqueExternalId#stringin query

  Similar to externalId but should be unique across all donors. Can be used to prevent duplicate donors.

• accountId#stringin queryUUID

  Id of the account. Only useful for Platform customers to filter donors by child accounts

• search#stringin queryat least 3 characters

  Full text search on the firstName, lastName and email fields. Minimum length: 3

  Required in the spec, optional for the API.

• sort#stringin query

  Sorting field and order

  createdAt:asccreatedAt:descfirstName:ascfirstName:desc

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

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