Contents x
    Retrieve submissions list
    • 19 Nov 2024
    • 1 Minute to read
    • Print
    • Dark
      Light
    Contents

    Retrieve submissions list

    • Updated on 19 Nov 2024
    • 1 Minute to read
    • Print
    • Dark
      Light
    Article summary

    Get
    /rn-powerups-api/1.0/api/{client_id}/submissions

    This API returns the list and details of ALL submission data including forms, questions, and answers proivded by the submitting Customer(s) or Patient(s).

    Header parameters
    xx-relay-api-key
    stringRequired

    Contains the API key needed.

    Path parameters
    client_id
    stringRequired

    Client ID

    Minimum1
    Query parameters
    form_id
    string

    The unique ID of the form submitted by the Customer or Patient.

    Max length100
    Example54dda2a2-a1fd-4122-876e-56c20ac81af88
    Responses
    200

    OK

    object
    ccid
    string

    Uniquely identifies a Customer or Patient.

    Max length100
    ExampleBAK-11984-007
    client_message_tag
    string

    This is a arbitrary passthrough property specified by the Client for reporting and tracking by the Client.

    Max length100
    ExamplecampaignA
    customer_id
    string

    tbd

    Max length100
    Exampletbd
    customer_name
    string

    tbd

    Max length100
    Exampletbd
    experience_name
    string

    tbd

    Max length100
    Exampletbd
    journey_id
    string

    tbd

    Max length100
    Exampletbd
    trigger_id
    string

    If specified, the onboarded Customer or Patient will be sent the experience associated with the specifiedi trigger_id.

    Max length100
    Example7028cb2e-d62d-4d5f-a285-91d25781ea86
    message_id
    string

    tbd

    Max length100
    Example7028cb2e-d62d-4d5f-a285-91d25781ea86
    product_group_id
    string

    The product group Id of the Customer or Patient. A Customer or Patient can only be assigned to a single product group.

    Max length100
    Exampledefault
    form_id
    string

    91671558-5d60-61b6-8c00-1eb1ea4cb776

    Max length100
    Exampledefault
    form_name
    string

    The name of the form.

    Max length100
    Exampledefault
    date_submitted_at
    string

    The date on which the form was submitted by the Customer or Patient.

    Max length100
    Exampledefault
    400

    Invalid request

    401

    Unauthorized

    404

    Not Found - The requested resource was not found. Please verify the route parameter.

    409

    Conflict - Indicates the request could not be processed. A common reason is when attempting to create a new Journey object, but the ID already exists in the system.

    500

    An unexpected server error occurred. The response body should contain additional information related to the server error. Please retry your request.

    Was this article helpful?
    What's Next