Access the Cognito Forms API with managed OAuth authentication. List forms, manage entries (create, read, update, delete), and retrieve documents.
Reference
List Forms
GET /cognito-forms/api/formsReturns all forms in the organization.
Get Entry
GET /cognito-forms/api/forms/{formId}/entries/{entryId}Returns a specific entry by ID or entry number.
Create Entry
POST /cognito-forms/api/forms/{formId}/entries
Content-Type: application/json
{
"Name": {
"First": "John",
"Last": "Doe"
},
"Email": "john.doe@example.com",
"Phone": "555-1234"
}Field names match your form's field names. Complex fields like Name and Address use nested objects.
Update Entry
PATCH /cognito-forms/api/forms/{formId}/entries/{entryId}
Content-Type: application/json
{
"Name": {
"First": "Jane",
"Last": "Doe"
},
"Email": "jane.doe@example.com"
}Updates an existing entry. Uses PATCH method (not PUT). Fails if the entry includes a paid order.
Delete Entry
DELETE /cognito-forms/api/forms/{formId}/entries/{entryId}Deletes an entry. Requires Read/Write/Delete API scope.
Get Document
GET /cognito-forms/api/forms/{formId}/entries/{entryId}/documents/{templateNumber}Generates and returns a document from an entry using the specified template number.
Response:
{
"Id": "abc123",
"Name": "Entry-Document.pdf",
"ContentType": "application/pdf",
"Size": 12345,
"File": "https://temporary-download-url..."
}Get File
GET /cognito-forms/api/files/{fileId}Retrieves a file uploaded to a form entry.
Response:
{
"Id": "file-id",
"Name": "upload.pdf",
"ContentType": "application/pdf",
"Size": 54321,
"File": "https://temporary-download-url..."
}