API Documentation

• Endpoint: GET /api/v2/stories/:id

• Authentication: Requires valid authentication token

• Response Format: JSON

• Query Parameter

  • id (integer): The unique identifier for the story

Response Attributes

• id (integer): Unique identifier for the story.

• text (string, nullable): The text content of the story.

• number (string): Story number.

• approved (boolean): Indicates whether the story is approved.

• story_group (string): Group to which the story belongs.

• location (string, nullable): Location associated with the story.

• project_id (integer): Identifier of the associated project.

• charity_id (integer, nullable): Identifier of the associated charity.

• story_category_id (integer): Identifier of the story category.

• edited_by (integer): User ID of the editor.

• user_id (integer): User ID of the creator.

• updated_at (string): Timestamp of the last update.

• created_at (string): Timestamp of creation.

• actual_created_at (string): Actual creation timestamp.

• beneficiary_ids (array): List of beneficiary IDs associated with the story.

• case_ids (array): List of case IDs associated with the story.

• custom_fields (array): Custom fields associated with the story.

  • id (integer): Custom field ID.

  • name (string): Name of the custom field.

  • type (string): Type of the custom field.

  • value (string): Value of the custom field.

• story_indicator_beneficiaries (array): Indicators associated with beneficiaries in the story.

  • id (integer): ID of the indicator-beneficiary association.

  • beneficiary_id (integer): ID of the beneficiary.

  • indicator_id (integer): ID of the indicator.

  • indicator_type (string): Type of the indicator.

  • sub_ratio_id (integer): ID of the sub-ratio.

  • outcome_id (integer): ID of the outcome.

• story_change_beneficiaries (array): Beneficiaries associated with story changes.

• story_changes (array): List of story changes.

Example

GET https://makerble.com/api/v2/stories/368376

Response

Example video

Open