Users

The Daffy API let's you get information about you and other Daffy users

Get Your Profile

Resource

GET    /v1/users/me

Sample Response

{
  "id": 1,
  "name": "Api User Name",
  "avatar": "https://static.daffy.org/avatars/1/api-user-avatar",
  "cover_image": "https://static.daffy.org/covers/1/api-user-cover",
  "slug": "api-user",
  "fund_name": "Api User Fund",
  "current_fund": {
    "id": 1,
    "name": "Api User Fund",
    "summary": "Api User Summary",
    "causes": [
      {
        "id": 11,
        "name": "International",
        "color": "#FEC398",
        "logo": "https://static.daffy.org/assets/default-non-profit-avatars/Default_International.png"
      }
    ],
    "users": [
      {
        "id": 1,
        "name": "Api User",
        "avatar": "https://static.daffy.org/avatars/1/api-user-avatar",
        "slug": "api-user"
      },
      {
        "id": 2,
        "name": "Api User's Spouse",
        "avatar": "https://static.daffy.org/avatars/1/api-user-spouse-avatar",
        "slug": "api-user-spouse"
      }
    ]
  },
  "follows_user": false,
  "follows_viewer": false,
  "onboarding_status": "none"
}

Response Reference

Name	Type	Description
`id`	number	The ID of the user
`name`	string	The name of the user
`avatar`	string	The URL of the user's avatar
`cover_image`	string	The URL of the user's cover image
`slug`	string	The slug of the user's profile
`fund_name`	string	The name of the user's fund
`current_fund`	object	Current fund object associated with the user. It has its own properties
`follows_user`	boolean	Whether the viewer is following this user
`follows_viewer`	boolean	Whether this user is followed by the viewer
`fund.id`	number	The ID of the fund
`fund.name`	string	The name of the fund
`fund.summary`	string	The summary of the fund
`fund.causes.id`	number	The ID of the cause
`fund.causes.name`	string	The name of the cause
`fund.causes.color`	string	The color associated with the cause
`fund.causes.logo`	string	The URL of the cause's logo
`fund.users.id`	number	The ID of the user
`fund.users.name`	string	The name of the user
`fund.users.avatar`	string	The URL of the user's avatar
`fund.users.slug`	string	The slug of the user's profile
`onboarding_status`	string	The status of the user's onboarding process. Possible values are `none`,`complete`

Sample Request

curl "https://public.daffy.org/v1/users/me" -H 'X-Api-Key: <YOUR KEY HERE>'

Get User Profile by username

Resource

GET    /v1/users/:username

Path Params

Name	Type	Description
`username`	string	username

Sample Response

{
  "id": 1,
  "name": "Api User Name",
  "avatar": "https://static.daffy.org/avatars/1/api-user-avatar",
  "cover_image": "https://static.daffy.org/covers/1/api-user-cover",
  "slug": "api-user",
  "fund_name": "Api User Fund",
  "current_fund": {
    "id": 1,
    "name": "Api User Fund",
    "summary": "Api User Summary",
    "causes": [
      {
        "id": 11,
        "name": "International",
        "color": "#FEC398",
        "logo": "https://static.daffy.org/assets/default-non-profit-avatars/Default_International.png"
      }
    ],
    "users": [
      {
        "id": 1,
        "name": "Api User",
        "avatar": "https://static.daffy.org/avatars/1/api-user-avatar",
        "slug": "api-user"
      },
      {
        "id": 2,
        "name": "Api User's Spouse",
        "avatar": "https://static.daffy.org/avatars/1/api-user-spouse-avatar",
        "slug": "api-user-spouse"
      }
    ]
  },
  "follows_user": false,
  "follows_viewer": false,
  "onboarding_status": "none"
}

Response Reference

Name	Type	Description
`id`	number	The ID of the user
`name`	string	The name of the user
`avatar`	string	The URL of the user's avatar
`cover_image`	string	The URL of the user's cover image
`slug`	string	The slug of the user's profile
`fund_name`	string	The name of the user's fund
`current_fund`	object	Current fund object associated with the user. It has its own properties
`follows_user`	boolean	Whether the viewer is following this user
`follows_viewer`	boolean	Whether this user is followed by the viewer
`fund.id`	number	The ID of the fund
`fund.name`	string	The name of the fund
`fund.summary`	string	The summary of the fund
`fund.causes.id`	number	The ID of the cause
`fund.causes.name`	string	The name of the cause
`fund.causes.color`	string	The color associated with the cause
`fund.causes.logo`	string	The URL of the cause's logo
`fund.users.id`	number	The ID of the user
`fund.users.name`	string	The name of the user
`fund.users.avatar`	string	The URL of the user's avatar
`fund.users.slug`	string	The slug of the user's profile
`onboarding_status`	string	The status of the user's onboarding process. Possible values are `none`,`complete`

Sample Request

curl "https://public.daffy.org/v1/users/api-user" -H 'X-Api-Key: <YOUR KEY HERE>'

Pagination