Skip to main content

Get consent forms

GET 
/v1/partner/locations/:location_id/consent-forms

This endpoint returns the consent forms configured in the Solv settings at the location specified by location_id. The response contains an array of objects that represents a location and its consent forms.

Token scope:

{'scope': 'read:locations'}

Request​

Path Parameters

    location_id Location Idrequired

    Required. The unique identifier of the location.

Query Parameters

    limit Limit

    Default value: 20

    Optional. The maximum number of consent forms to return.

    page Page

    Default value: 1

Responses​

Successful Response

Schema

    page

    object

    required

    limit Limit (integer)required

    links

    object[]

    required

  • Array [

    • href Href (string)
    rel Rel (string)required

  • ]

    • page Page (integer)required
    results_count Results Count (integer)required

    results

    object[]

    required

  • Array [

    • active Active (boolean)required
    aws_bucket_name Aws Bucket Name (string)required
    aws_path Aws Path (string)required
    created_date date-timerequired
    display_name Display Name (string)required
    dynamic_template_filename Dynamic Template Filename (string)
    form_type Form Type (string)required
    id Id (integer)required
    location_id Location Id (integer)required
    updated_date date-timerequired

  • ]

Loading...