getGet multiple inquiries (TBA)

❗

Authorization Required

This endpoint requires authentication via the Core API Auth server.
Learn about authentication →

Get multiple inquiries at a time. Supports cursor-based pagination.
curl --request GET \
  --url 'https://api.test.neobits.no/fuse/v2/inquiries?filter[isCompleted]=false&page[after]=df786f04a209&page[before]=5061496e&page[size]=10&order=asc&sort=createdAt' \
  --header 'Authorization: Basic REPLACE_BASIC_AUTH'

Request

Headers

  • Authorization•string

    Basic authentication, base64 encoded username:password.

Params (query)

  • filter[isCompleted]•boolean

    Filter the inquiries by completion status.

  • page[after]•string

    Fetch inquiries after this cursor

  • page[before]•string

    Fetch inquiries before this cursor

  • page[size]•integer

    The maximum number of inquiries to return

  • order•string

    The order of the inquiries. Defaults to asc.

  • sort•string

    The field to sort the inquiries by. Defaults to createdAt.

Response

Headers

  • Content-Type•string

    The content type of the response.

  • X-Request-ID•string<uuid>

    UUID generated on each request. Provide this id to customer support if an error occurs.

Body

  • metadata•object

    • page•object

      • size•integer

        The maximum number of items to return.

      • total•integer

        The number of items in the results set.

      • after•string

        The cursor to fetch the next page of inquiries.

      • before•string

        The cursor to fetch the previous page of inquiries.

  • data•array<object>

    • id•string<uuid>

    • ssn•string

      The unique identifier for the person the inquiry is for.

    • url•string<uri>

      Give this URL to the user so they can start the flow.

    • externalId•string

      Optional identifier the consumer of the API can provide. Will be added to the event callback.

    • skipConsentMessages•boolean

      Will skip messages explaining to the user which consents are needed to complete the flow.

    • isCompleted•boolean

      Indicates if the inquiry is completed or not by the user.

    • createdAt•string<date-time>

      Inquiry created date

    • updatedAt•string<date-time>

      Inquiry last updated date

    • notifications•array<object>

      The notification options set for the inquiry.

      • type•string

      • message•string

        The consumer of the API can decide where to place the link to initate the process by passing in $link (see example)

      • to•string

        The phone number you want the text message to be sent to

    • redirect•object

      URL's provided here will decide where the user should be sent on flow completion

      • onSuccess•string<url>

        URL to send the user to after the data is fetched

      • onError•string<url>

        URL to send the user to when an error occurs. See the "Error handling" section above for more info.

    • metadata•object

      • sbl•object

        • authCode•string

          Auhtorization code received from Altinn. Used to retrieve the customers data from Skatteetaten.

    • prerequisites•array<object>

      Prerequisites are actions that the user must complete before the data can be fetched. They can either be consents that must be given, or flows that must be completed.

      • name•string

      • isCompleted•boolean

        Whether the prerequisite has been completed or not. When the prerequisite requires the user to give prior consent, this field will be true if the user has given consent.

      • consentUrl•string<uri>

        The URL neobits will redirect the user to internally, so the user can complete the prerequisite.