Apis::V4::Organizations::CelebrationItems API

get organization's celebration items

Parameters

Name	Description
filters	comma delimited filters. Filter options: - filters[subject_person_ids] = 1,2,3 - filters[has_unread_comments] = true (Only return items that have one or more unread comments, for the current person only. Unread comments are tracked through the unread_items relationship on the celebration_item_comments objects.)
access_token	JSON Web Token retrieved from the Sessions endpoint (you can also pass this into the Authorization header)
page[limit]	The max number of results expected
page[offset]	The offset of results expected
fields	A comma separated list of fields to return in the response for the given type. A resource object's attributes and its relationships are collectively called its 'fields'. Clients may restrict the set of fields in order to improve performance. Multiple types can be specified. If no fields param is specified then by default all fields are returned. Example

Response Fields

Name	Description
data	primary JSON API payload
meta	will contain additional information about the current request, including the total number of records before the limit/offset operations

Request

Headers

Version: HTTP/1.0
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxNjksImV4cCI6MTcwNDQ3MzIzNCwiaWF0IjoxNzA0NDczMDU0fQ.TGVgx7gZzJDlQ5KQohpBqJuU2hsAUBrSwgkdUtMrxbg
Host: example.org
Cookie:

Route

GET /apis/v4/organizations/120/celebration_items

Response

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/vnd.api+json
Vary: Accept
X-MH-Session: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxNjksImV4cCI6MTcwNDY0NTg1NCwiaWF0IjoxNzA0NDczMDU0fQ.WJp6WbYjhoG98TrP4wp5zA66Tb_vQxrdzktaK5Brgrc
Access-Control-Expose-Headers: X-MH-Session
ETag: W/"8704dba1224b0c7120c656ccf0c061c8"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: fb993159-5871-401d-8b8e-e94f4ff1f4be
X-Runtime: 0.084743
Content-Length: 1711

Status

Body

{
  "data": [
    {
      "id": "15",
      "type": "celebration_items",
      "attributes": {
        "adjective_attribute_name": null,
        "adjective_attribute_value": null,
        "celebrateable_id": "68",
        "celebrateable_type": "interaction",
        "changed_attribute_name": "created_at",
        "changed_attribute_value": "2024-01-05T16:44:14Z",
        "liked": false,
        "likes_count": 0,
        "comments_count": null,
        "object_type": null,
        "personal_ministry": false,
        "subject_person_name": "John Doe",
        "object_description": null
      },
      "relationships": {
        "organization": {
          "data": {
            "id": "120",
            "type": "organization"
          }
        },
        "subject_person": {
          "data": {
            "id": "309",
            "type": "person"
          }
        }
      }
    }
  ],
  "included": [
    {
      "id": "120",
      "type": "organization",
      "attributes": {
        "name": "organization_name_116",
        "terminology": "Organization",
        "ancestry": null,
        "show_sub_orgs": true,
        "created_at": "2024-01-05T16:44:14Z",
        "updated_at": "2024-01-05T16:44:14Z",
        "community": true,
        "community_photo_url": null,
        "community_code": "CF187A",
        "community_url": "rSg6sk8KmZFO19M5NYONOw",
        "unread_comments_count": 0,
        "welcome_message": null
      },
      "relationships": {
        "community_challenges": {
          "data": []
        }
      }
    },
    {
      "id": "309",
      "type": "person",
      "attributes": {
        "created_at": "2024-01-05T16:44:14Z",
        "fb_uid": 0,
        "first_name": "John",
        "full_name": "John Doe",
        "gender": "Male",
        "last_name": "Doe",
        "picture": "https://graph.facebook.com/v2.12/0/picture",
        "updated_at": "2024-01-05T16:44:14Z",
        "relationship_type": null
      },
      "relationships": {
        "email_addresses": {
          "data": [
            {
              "id": "197",
              "type": "email_address"
            }
          ]
        },
        "pathway_progression_audits": {
          "data": []
        },
        "phone_numbers": {
          "data": []
        },
        "user": {
          "data": {
            "id": "170",
            "type": "user"
          }
        },
        "received_challenges": {
          "data": []
        },
        "person_notes": {
          "data": []
        },
        "reverse_contact_assignments": {
          "data": []
        },
        "interactions": {
          "data": []
        },
        "contact_assignments": {
          "data": []
        },
        "organizational_permissions": {
          "data": []
        }
      }
    }
  ],
  "meta": {
    "total": 1
  }
}