GET api/forms/{id}?fields={fields}

Gets a single form, specified by its ID.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

REQUIRED - The id of the form to retrieve.

globally unique identifier

Required

fields

OPTIONAL - Specifies a comma-separated list of the fields to return for each matching form in the result set.

string

None.

Body Parameters

None.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json

Sample:
{
  "Id": "4cf5ed76-1785-446a-9dac-aef9f8f6fc06",
  "Filename": "SampleFile.PDF",
  "Filetype": "PDF",
  "Filepath": "C:/SamplePath/SampleFile.PDF",
  "Uri": "http://sampleuri.sample",
  "FileData": null,
  "Title": "Sample Title",
  "Description": "Sample description",
  "Tags": "Tag1,Tag2",
  "LastModified": "2026-08-20T13:15:14.4850725-07:00",
  "Version": null,
  "Filesize": 1233334,
  "Pages": 5,
  "State": "AK",
  "Organization": "BCBS",
  "Owner": "Symed",
  "Checksum": "33uPNEA=",
  "FormType": 0
}

text/json, text/html

Sample:
{
  "Id": "4cf5ed76-1785-446a-9dac-aef9f8f6fc06",
  "Filename": "SampleFile.PDF",
  "Filetype": "PDF",
  "Filepath": "C:/SamplePath/SampleFile.PDF",
  "Uri": "http://sampleuri.sample",
  "FileData": null,
  "Title": "Sample Title",
  "Description": "Sample description",
  "Tags": "Tag1,Tag2",
  "LastModified": "2026-08-20T13:15:14.637814-07:00",
  "Version": null,
  "Filesize": 1233334,
  "Pages": 5,
  "State": "AK",
  "Organization": "BCBS",
  "Owner": "Symed",
  "Checksum": "33uPNEA=",
  "FormType": 0
}

application/xml, text/xml

Sample:

Sample not available.