Apis::V4::Organizations::CelebrationItems::Comments API

get organization celebration comments

Parameters

Name	Description
access_token	JSON Web Token retrieved from the Sessions endpoint (you can also pass this into the Authorization header)
page	pagination details: - page[limit] = number of records you want to receive per page, default 25 - page[offset] = skip the first n number of records before reading organizations, default 0
sort	order you want to receive records in, default created_at
include	comma delimited relationships you want included in the response in snake_case format

Response Fields

Name	Description
data	primary JSON API payload
included	related models (controlled by the include param)
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.eyJ1c2VyX2lkIjoxNzEsImV4cCI6MTcwNDQ3MzIzNSwiaWF0IjoxNzA0NDczMDU1fQ.Ql6-XYOzppEp5gg8Hy8cFiirUtpI4APEJa8A7lm1T7s
Host: example.org
Cookie:

Route

GET /apis/v4/organizations/122/celebration_items/16/comments?include=*

Query Parameters

include=*

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.eyJ1c2VyX2lkIjoxNzEsImV4cCI6MTcwNDY0NTg1NSwiaWF0IjoxNzA0NDczMDU1fQ.-kHiajiB-T82-2FBLJwatmyHzw8zB-f5GPgz88pEQNE
Access-Control-Expose-Headers: X-MH-Session
ETag: W/"1fbdb230814a26aebcbdc5742f1be1f2"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 444437e5-4dd3-427f-a322-4ebe98a35248
X-Runtime: 0.089764
Content-Length: 1661

Status

Body

{
  "data": [
    {
      "id": "9",
      "type": "celebration_item_comments",
      "attributes": {
        "content": "test comment content",
        "updated_at": "2024-01-05T16:44:14Z",
        "created_at": "2024-01-05T16:44:14Z"
      },
      "relationships": {
        "organization_celebration_item": {
          "data": {
            "id": "16",
            "type": "celebration_items"
          }
        },
        "person": {
          "data": {
            "id": "312",
            "type": "person"
          }
        },
        "unread_items": {
          "data": []
        }
      }
    }
  ],
  "included": [
    {
      "id": "16",
      "type": "celebration_items",
      "attributes": {
        "adjective_attribute_name": null,
        "adjective_attribute_value": null,
        "celebrateable_id": "69",
        "celebrateable_type": "interaction",
        "changed_attribute_name": "created_at",
        "changed_attribute_value": "2024-01-05T16:44:14Z",
        "liked": false,
        "likes_count": 0,
        "comments_count": 1,
        "object_type": null,
        "personal_ministry": false,
        "subject_person_name": "John Doe",
        "object_description": null
      },
      "relationships": {
        "organization": {
          "data": {
            "id": "122",
            "type": "organization"
          }
        },
        "subject_person": {
          "data": {
            "id": "313",
            "type": "person"
          }
        }
      }
    },
    {
      "id": "312",
      "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": "198",
              "type": "email_address"
            }
          ]
        },
        "pathway_progression_audits": {
          "data": []
        },
        "phone_numbers": {
          "data": []
        },
        "user": {
          "data": {
            "id": "171",
            "type": "user"
          }
        },
        "received_challenges": {
          "data": []
        },
        "person_notes": {
          "data": []
        },
        "reverse_contact_assignments": {
          "data": []
        },
        "interactions": {
          "data": []
        },
        "contact_assignments": {
          "data": []
        },
        "organizational_permissions": {
          "data": [
            {
              "id": "208",
              "type": "organizational_permission"
            }
          ]
        }
      }
    }
  ],
  "meta": {
    "total": 1
  }
}