### Example Formstack API Resource URLs Source: https://developers.formstack.com/reference/api-overview/index Demonstrates how to construct API URLs for different resources and desired response formats (JSON or XML). ```Text https://www.formstack.com/api/v2/form.json https://www.formstack.com/api/v2/form/12334/submission.xml ``` -------------------------------- ### Authenticate Formstack API with OAuth Token Query Parameter Source: https://developers.formstack.com/reference/api-overview/index Illustrates how to pass the OAuth2 access token as a query string parameter for GET API calls. ```Text https://www.formstack.com/api/v2/form.json?oauth_token=abcdefg123456 ``` -------------------------------- ### Formstack REST API Endpoints Reference Source: https://developers.formstack.com/reference/api-overview/index This section provides a detailed reference of all accessible endpoints within the Formstack REST API. Each entry specifies the HTTP method (GET, POST, PUT, DELETE) and the corresponding API path, organized by resource category for easy navigation and understanding of the API's capabilities. ```APIDOC REST API Endpoints: Authorization: GET /oauth2/authorize POST /oauth2/token Forms: GET /form POST /form GET /form/:id PUT /form/:id DELETE /form/:id POST /form/:id/copy GET /form/:id/basic GET /form/:id/html Fields: GET /form/:id/field POST /form/:id/field GET /field/:id PUT /field/:id DELETE /field/:id Folders: GET /folder POST /folder GET /folder/:id PUT /folder/:id DELETE /folder/:id Submissions: GET /submission GET /form/:id/submission POST /form/:id/submission GET /submission/:id PUT /submission/:id DELETE /submission/:id GET /form/:id/count GET /download/:submission_id/:field_id/:index Partial Submissions: GET /form/:id/partialsubmission GET /partialsubmission/:id DELETE /partialsubmission/:id Confirmation Emails: GET /form/:id/confirmation POST /form/:id/confirmation GET /confirmation/:id PUT /confirmation/:id DELETE /confirmation/:id Notification Emails: GET /form/:id/notification POST /form/:id/notification GET /notification/:id PUT /notification/:id DELETE /notification/:id Webhooks: GET /form/:id/webhook POST /form/:id/webhook GET /webhook/:id PUT /webhook/:id DELETE /webhook/:id Portals: GET /portal GET /portal/:id PUT /portal/:id DELETE /portal/:id POST /portal/:id/copy POST /portal/:id/avatar DELETE /portal/:id/avatar POST /portal/:id/user DELETE /portal/:id/user PUT /portal/:id/user POST /portal/:id/form PUT /portal/:id/form/:portalFormId DELETE /portal/:id/form/:portalFormId Smart Lists: GET /smartlist POST /smartlist GET /smartlist/:id PUT /smartlist/:id DELETE /smartlist/:id GET /smartlist/:id/option POST /smartlist/:id/option GET /smartlist/:id/option/:optionId PUT /smartlist/:id/option/:optionId DELETE /smartlist/:id/option/:optionId DELETE /smartlist/:id/option/:optionId/image POST /smartlist/:id/option/:optionId/image DELETE /smartlist/:id/alloptions POST /smartlist/:id/bulkoptions Subaccounts: GET /subaccount ``` -------------------------------- ### Partner API Endpoint Reference Source: https://developers.formstack.com/reference/api-overview/index Reference for Partner API endpoints, including SSO configuration, subaccount management, and subaccount billing/provisioning functionalities. ```APIDOC Partner API Endpoints: General: GET /{organizationId}/subaccounts/{subaccountId}/sso/config GET /{organizationId}/subaccounts GET /{organizationId}/subaccounts/{subaccountId}/app-api-keys Subaccount Billing & Provisioning: GET /{organizationId}/subaccounts/products POST /api/v1/organizations/{organizationId}/subaccounts/preview POST /api/v1/organizations/{organizationId}/subaccountspost ``` -------------------------------- ### SCIM API Endpoint Reference Source: https://developers.formstack.com/reference/api-overview/index Reference for SCIM (System for Cross-domain Identity Management) API endpoints, covering user, group, form, and folder operations. ```APIDOC SCIM API Endpoints: Users: GET /Users POST /Users GET /Users/:id PUT /Users/:id PATCH /Users/:id DELETE /Users/:id Groups: GET /Groups POST /Groups GET /Groups/:id PUT /Groups/:id PATCH /Groups/:id DELETE /Groups/:id Forms: GET /Forms GET /Forms/:id Folders: GET /Folders GET /Folders/:id ``` -------------------------------- ### Formstack API HTTP Status Codes Reference Source: https://developers.formstack.com/reference/api-overview/index This section outlines the standard HTTP status codes returned by the Formstack API. It includes codes for successful requests, client-side errors, and server-side errors, providing a clear understanding of API responses. ```APIDOC Status Codes: 200: OK - The request was handled without any errors 201: Created - A new resource was created 400: Bad Request - The request URI was invalid 401: Unauthorized - Valid OAuth2 credentials were not supplied 403: Forbidden - The current user does not have access to this method 404: Not Found - The resource requested could not be found 405: Method Not Allowed - The requested method does not exist 415: Unsupported Media Type - A valid media type (JSON, XML, HTTP URL encoded) was not used 429: Too Many Requests - The current user has hit the daily rate limit 500: Internal Server Error - An error occurred while processing the request ``` -------------------------------- ### Authenticate Formstack API with Bearer Token Header Source: https://developers.formstack.com/reference/api-overview/index Shows how to include the OAuth2 access token in the HTTP Authorization header for authenticated API calls. ```HTTP Authorization: Bearer ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.