v1

latestOpenAPI 3.0.0Apache 2.02026-07-2410185524.2 KB
Profiles

all posts

Returns a list of posts you've previously created. The posts will be returned in descending order of when they were created, unless you specify otherwise.

For custom components:

RaiselyComponents.api.one('profiles', '{path}').get('posts', params = {}, headers = {}) => Promise<{result}>

:fa-gears: See Restie Response Data for a more detailed overview of responses through the client wrapper

get/profiles/{path}/posts

Path parameters

pathstring required

The uuid or path of the record

Query parameters

privateboolean

Returns the full record when authenticated

qstring

Search query to find records matching

limitnumber

The number of records to limit per page

offsetnumber

The pagination offset (in number of records)

sortstring

The record attribute to filter on (use in conjunction with order)

order'asc' | 'desc'

The direction to sort (only applied if sort is also provided) * asc - Ascending * desc - Descending

profilestring

Filter by profile path or uuid

campaignstring

Filter by campaign path or uuid

Headers

Authorizationstring

A valid HTTP Bearer token, required to access private records.

Response

The resulting collection of Post records

Example response

{
  "data": [
    {
      "body": "<p>My example post here</p>",
      "campaignUuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
      "createdAt": "2020-12-03T06:52:46.330Z",
      "date": "2020-12-03T06:52:46.330Z",
      "path": "example-path",
      "photoUrl": "https://source.unsplash.com/random/800x600",
      "profile": {
        "activityTotal": 2625,
        "activityTotalPercent": 2625,
        "campaignDisplayTotal": 2625,
        "createdAt": "2020-12-03T06:52:46.330Z",
        "currency": "AUD",
        "description": "I believe in a better world",
        "donationCount": 12345,
        "donationRecordCount": 12345,
        "exerciseGoal": 12345,
        "exerciseGoalTime": 12345,
        "exerciseTotal": 2625,
        "exerciseTotalTime": 2625,
        "fundraiserTheme": "birthday",
        "goal": 100050,
        "individualProfileCount": 12345,
        "isCampaignProfile": true,
        "name": "Bob D.",
        "nonSelfDonationTotal": 2625,
        "organisationProfileCount": 12345,
        "paid": true,
        "path": "bobd",
        "photoUrl": "https://raisely-images.imgix.net/www/uploads/t-03-arl-8-es-uhhqua-4-pr-f-4865431-df-58-512-png-08e3f5.png",
        "private": {
          "fieldA": "one",
          "fieldB": "yes"
        },
        "public": {
          "fieldA": "one",
          "fieldB": "yes"
        },
        "selfDonationTotal": 2625,
        "shared": true,
        "status": "ACTIVE",
        "subscriptionCount": 12345,
        "teamProfileCount": 12345,
        "type": "INDIVIDUAL",
        "uniqueDonors": 12345,
        "updatedAt": "2020-12-03T06:52:46.330Z",
        "uuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      },
      "profileUuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
      "tags": [
        {
          "color": "#ff0000",
          "createdAt": "2020-12-03T06:52:46.330Z",
          "internal": {},
          "isPrivate": true,
          "label": "My Custom Tag",
          "organisationUuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
          "path": "example-path",
          "recordType": "user",
          "updatedAt": "2020-12-03T06:52:46.330Z",
          "uuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
        }
      ],
      "title": "My Blog Title",
      "updatedAt": "2020-12-03T06:52:46.330Z",
      "user": {
        "accessToken": "aaabbbccc",
        "address1": "31 Sunset Boulevard",
        "address2": "Unit 31b",
        "adminSettings": {
          "v4BetaOptin": true,
          "starredCampaigns": [
            "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
            "ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj"
          ]
        },
        "country": "AU",
        "createdAt": "2020-12-03T06:52:46.330Z",
        "email": "harveymilk@example.com",
        "facebookId": "fb_someurl",
        "firstName": "Leila",
        "fullName": "Leila Norma de Lima",
        "internal": {},
        "isAdmin": true,
        "isSamlLogin": true,
        "lastName": "de Lima",
        "permission": "PARTICIPANT",
        "phoneNumber": "+1 123-456-7890",
        "photoUrl": "https://raisely-images.imgix.net/www/uploads/t-03-arl-8-es-uhhqua-4-pr-f-4865431-df-58-512-png-08e3f5.png",
        "postcode": "AAA BBBB",
        "preferredName": "Norma",
        "private": {
          "fieldA": "one",
          "fieldB": "yes"
        },
        "public": {
          "fieldA": "one",
          "fieldB": "yes"
        },
        "state": "Victoria",
        "status": "ACTIVE",
        "suburb": "Melbourne",
        "unsubscribedAt": "2020-12-03T06:52:46.330Z",
        "updatedAt": "2020-12-03T06:52:46.330Z",
        "username": "harveymilk@example.com",
        "uuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      },
      "userUuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
      "uuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
    }
  ],
  "pagination": {
    "total": 10,
    "pages": 2,
    "offset": 5,
    "limit": 5
  }
}