Forms
Get a list of forms
API Reference
- Introduction
- Authentication
- Authorization
- Endpoints
- Me
- Announcements
- Attachments
- Awards
- Cache
- Calendars
- Categories
- Comments
- Documents
- Events
- Forms
- Groups
- Images
- Messages
- Newsfeed
- Positions
- Qualifications
- Ranks
- Records
- Roster
- Settings
- Specialties
- Statuses
- Submissions
- Tasks
- Units
- Users
Forms
Get a list of forms
GET
/
{version}
/
categories
/
{category}
/
forms
curl --request GET \
--url https://api.perscom.io/{version}/categories/{category}/forms \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"id": 123,
"submission_status_id": 123,
"name": "<string>",
"slug": "<string>",
"success_message": "<string>",
"is_public": false,
"description": "<string>",
"instructions": "<string>",
"label": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"links": {
"first": "<string>",
"last": "<string>",
"prev": "<string>",
"next": "<string>"
},
"meta": {
"current_page": 123,
"from": 123,
"last_page": 123,
"path": "<string>",
"per_page": 123,
"to": 123,
"total": 123
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
The API version to use.
Available options:
v1
, v2
Query Parameters
Available options:
fields
, submissions
, submissions.*
, tags
Response
200
application/json
OK
Supports HTML.
Supports HTML.
Supports HTML.
The date the resource was created. Stored in UTC.
The date the resource was updated. Stored in UTC.
Was this page helpful?
curl --request GET \
--url https://api.perscom.io/{version}/categories/{category}/forms \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"id": 123,
"submission_status_id": 123,
"name": "<string>",
"slug": "<string>",
"success_message": "<string>",
"is_public": false,
"description": "<string>",
"instructions": "<string>",
"label": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"links": {
"first": "<string>",
"last": "<string>",
"prev": "<string>",
"next": "<string>"
},
"meta": {
"current_page": 123,
"from": 123,
"last_page": 123,
"path": "<string>",
"per_page": 123,
"to": 123,
"total": 123
}
}