Every aspect of Engine Awesome is accessible via our REST API, allowing you to programmatically interact with and manipulate the data in your application. Whether you're managing objects, or customizing your app’s features, the API provides a comprehensive set of endpoints to suit your needs.
\nAll of our endpoints begin with your unique Engine Awesome domain, which is assigned to your team when you sign up: https://[team_slug].engineawesome.app
By using your custom domain, you can securely and efficiently make API calls to access and modify your data, integrate with third-party tools, and enhance your workflows. The API is designed to be flexible and user-friendly, empowering you to build and customize your application to meet the specific needs of your business.
\npage: The page number to fetch (default: 1).
per_page: The number of items to include per page (default: 10).
Example: https://dundermifflin.engineawesome.app/api/v1/object-types?page=2&per_page=15
Date: When POST or PUT with a Date field in the body, the format should be UTC, without microseconds (e.g. \"2025-03-10T07:59:54Z\")
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"1491352","collectionId":"52fadd8a-1a00-4a74-b816-ad8ffae0be7b","publishedId":"2sBYHRTft2","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-10-11T16:17:50.000Z"},"item":[{"name":"Object Types","item":[{"name":"Object Types","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","packages":{},"id":"6d917e97-7cb4-4852-adff-5292d1e7b5c4"}}],"id":"5f483f1d-e6ef-420c-a298-98f23470d6df","protocolProfileBehavior":{"followRedirects":true,"disableUrlEncoding":false,"disableCookies":false,"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{team_slug}}.engineawesome.app/api/v1/object-types","description":"Returns every object type on your team, such as Contacts, Projects, Tasks or Donations. Use the id of an object type with the Object endpoints to read and write its records.
Any member of the team can call this endpoint.
\nsearch (optional): only return object types whose name contains this text. The match is case-sensitive.This is a GET request and does not require a request body.
\nA JSON array (not wrapped in a data key). Each object type has:
id: the object type's UUID.name: the plural name, for example Contacts.labels: an object that always includes singular, for example Contact. If no singular label was set, it is derived from name.content: the block markup of the object type's form.relationships: every relationship this object type takes part in, in both directions. Each has:id: {objectTypeId}/{fieldSlug}/{kind}slug: the slug of the relationship field.label: a readable description, for example A Company has many Contacts.inverse: false when the relationship field is on this object type, true when it is on the other one.object_type: the ID of the other object type.kind: hasOne or hasMany.fields: every field, each with name (the block type, for example awesome/text-field), attributes (including slug, label, searchable, show_in_list, required and locking), children and isValid. When field-level permissions are configured, a field also has fga.view.hasPermission and fga.update.hasPermission.groups: field groups, each with attributes.slug, attributes.label and fields (a list of field slugs).object_label_fields: the slugs of the fields used to build each record's display label.notes: internal notes for app builders. Only included if you are allowed to update the object type.created_at, updated_at: ISO 8601 timestamps._links.self[0].href: the object type's API path. _links.self[0].targetHints.allow lists the methods you are allowed to use on it (GET, PUT, DELETE).Allow: always includes GET. Includes POST when you are allowed to create object types and your plan has room for another one.[\n {\n \"id\": \"00a5579c-9fc3-4fb6-bb56-89dbf21f862f\",\n \"name\": \"Companies\",\n \"labels\": { \"singular\": \"Company\" },\n \"content\": \"<!-- wp:awesome/text-field ... /-->\",\n \"relationships\": [\n {\n \"id\": \"aef3b3cc-31c1-40f5-8ab6-bdb3d8bb47f5/company/hasMany\",\n \"slug\": \"company\",\n \"label\": \"A Company has many Contacts\",\n \"inverse\": true,\n \"object_type\": \"aef3b3cc-31c1-40f5-8ab6-bdb3d8bb47f5\",\n \"kind\": \"hasMany\"\n }\n ],\n \"fields\": [\n {\n \"name\": \"awesome/text-field\",\n \"attributes\": {\n \"slug\": \"name\",\n \"label\": \"Name\",\n \"searchable\": true,\n \"show_in_list\": false,\n \"locking\": { \"always\": false, \"fields\": [] },\n \"required\": { \"always\": false, \"fields\": [] }\n },\n \"children\": [],\n \"isValid\": true\n }\n ],\n \"groups\": [],\n \"object_label_fields\": [\"name\"],\n \"created_at\": \"2023-04-02T00:16:14.000000Z\",\n \"updated_at\": \"2025-01-28T16:54:24.000000Z\",\n \"_links\": {\n \"self\": [\n {\n \"href\": \"/api/v1/object-types/00a5579c-9fc3-4fb6-bb56-89dbf21f862f\",\n \"targetHints\": { \"allow\": [\"GET\", \"PUT\", \"DELETE\"] }\n }\n ]\n }\n }\n]\nOptional. Only return object types whose name contains this text. The match is case-sensitive.
\n","type":"text/plain"},"key":"search","value":"Contact"}],"variable":[]}},"response":[{"id":"8e55511a-bdd1-4fc7-916d-40c0d611a4b5","name":"Object Types","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dundermifflin.engineawesome.app/api/v1/object-types"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"server","value":"nginx"},{"key":"content-type","value":"application/json"},{"key":"vary","value":"Accept-Encoding,Origin"},{"key":"cache-control","value":"no-cache, private"},{"key":"date","value":"Fri, 07 Feb 2025 19:12:21 GMT"},{"key":"allow","value":"GET"},{"key":"allow","value":"POST"},{"key":"x-ratelimit-limit","value":"600"},{"key":"x-ratelimit-remaining","value":"598"},{"key":"server-timing","value":"bootstrap;desc=\"Bootstrap\";dur=15.964984893799, database;desc=\"Database\";dur=57.67, app;desc=\"App\";dur=98, total;desc=\"Total\";dur=114.63904380798,"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"x-content-type-options","value":"nosniff"},{"key":"content-encoding","value":"gzip"},{"key":"transfer-encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"00a5579c-9fc3-4fb6-bb56-89dbf21f862f\",\n \"name\": \"Companies\",\n \"labels\": {\n \"singular\": \"Company\"\n },\n \"content\": \"\\nReturns one object type, such as Contacts or Projects, by its ID. Use it to look up the fields, relationships and labels of an object type before reading or writing its objects.
\nYou need permission to read object types on the team.
\nobjectType: the object type's UUID, from Get All Object Types.This is a GET request and does not require a request body.
\nA single object type, with the same properties as each item returned by Get All Object Types: id, name, labels, content, relationships, fields, groups, object_label_fields, notes (only if you are allowed to update the object type), created_at, updated_at and _links.
403: you don't have permission to read object types on this team.404: the ID is not a valid UUID, or no object type with that ID exists on this team.Returns a simple description of each field on an object type.
\nThis endpoint was originally created for our Zapier integration, but you can use it to list an object type's fields anywhere you need them: to let someone choose which field to search by, to build a field-mapping screen for an import or sync, or to check which fields are required or read-only before you create an object.
\nBy default it returns every field. Add searchable=1 to only return fields marked \"Is Searchable\". Those are the fields you can filter by with the Object: search by field endpoint.
File fields are never included.
\nobjectType: the object type's UUID.searchable (optional): 1 or true to only return searchable fields.A JSON array. Each field has:
\nkey: the field slug. Use it as the property name when reading, writing or searching objects.label: the field's label.placeholder: an example value, when the field's semantic type has one (for example 2022-01-31T12:30:00 for dates). Otherwise an empty string.type: string, text (multi-line text), boolean or datetime (text fields with the date semantic type).required: true if the field is always required.computed: true if the field is read-only.choices: for single- and multiple-choice fields, the allowed values.list: true for multiple-choice fields, whose value is an array.Relationship fields have a different shape: just key, label, dynamic and search. The last two are Zapier settings for looking up the related object; their value is the related object's _id.
The saved example below was captured without searchable, so it lists every field.
Only return fields marked \"Is Searchable\". Leave it out to return every field.
\n","type":"text/plain"},"key":"searchable","value":"1"}],"variable":[]}},"response":[{"id":"beccaf63-f6b2-459d-a778-3d4998199b67","name":"Searchable Fields for Object Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dundermifflin.engineawesome.app/api/v1/zapier/fields/aef3b3cc-31c1-40f5-8ab6-bdb3d8bb47f5"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"server","value":"nginx"},{"key":"content-type","value":"application/json"},{"key":"vary","value":"Accept-Encoding,Origin"},{"key":"cache-control","value":"no-cache, private"},{"key":"date","value":"Sun, 09 Feb 2025 02:48:56 GMT"},{"key":"x-ratelimit-limit","value":"600"},{"key":"x-ratelimit-remaining","value":"593"},{"key":"server-timing","value":"bootstrap;desc=\"Bootstrap\";dur=23.261070251465, database;desc=\"Database\";dur=68.78, app;desc=\"App\";dur=92, total;desc=\"Total\";dur=115.79298973083,"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"x-content-type-options","value":"nosniff"},{"key":"content-encoding","value":"gzip"},{"key":"transfer-encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"key\": \"first_name\",\n \"label\": \"First Name\",\n \"placeholder\": \"Name\",\n \"type\": \"string\",\n \"required\": true,\n \"computed\": false\n },\n {\n \"key\": \"last_name\",\n \"label\": \"Last Name\",\n \"placeholder\": \"Name\",\n \"type\": \"string\",\n \"required\": true,\n \"computed\": false\n },\n {\n \"key\": \"followup_date\",\n \"label\": \"Followup Date\",\n \"placeholder\": \"2022-01-31T12:30:00\",\n \"type\": \"datetime\",\n \"required\": false,\n \"computed\": false\n },\n {\n \"key\": \"followup_note\",\n \"label\": \"Followup Note\",\n \"placeholder\": \"\",\n \"type\": \"string\",\n \"required\": false,\n \"computed\": false\n },\n {\n \"key\": \"mobile_phone\",\n \"label\": \"Mobile Phone\",\n \"placeholder\": \"+1 (123) 123-1234\",\n \"type\": \"string\",\n \"required\": false,\n \"computed\": false\n },\n {\n \"key\": \"office_phone\",\n \"label\": \"Office Phone\",\n \"placeholder\": \"+1 (123) 123-1234\",\n \"type\": \"string\",\n \"required\": false,\n \"computed\": false\n },\n {\n \"key\": \"email\",\n \"label\": \"Email\",\n \"placeholder\": \"name@example.org\",\n \"type\": \"string\",\n \"required\": false,\n \"computed\": false\n },\n {\n \"key\": \"company\",\n \"label\": \"Company\",\n \"dynamic\": \"objectList.id._label\",\n \"search\": \"objectSearch.id\"\n },\n {\n \"key\": \"notes\",\n \"label\": \"Notes\",\n \"placeholder\": \"\",\n \"type\": \"text\",\n \"required\": false,\n \"computed\": false\n },\n {\n \"key\": \"type\",\n \"label\": \"Type\",\n \"placeholder\": \"\",\n \"type\": \"string\",\n \"required\": false,\n \"computed\": false,\n \"choices\": [\n \"Lead\",\n \"Customer\",\n \"Partner\",\n \"Inactive\"\n ]\n },\n {\n \"key\": \"status\",\n \"label\": \"Status\",\n \"placeholder\": \"\",\n \"type\": \"string\",\n \"required\": false,\n \"computed\": false,\n \"choices\": [\n \"New\",\n \"Followup\",\n \"Meeting Scheduled\",\n \"Dead\"\n ]\n },\n {\n \"key\": \"acquired\",\n \"label\": \"Acquired\",\n \"placeholder\": \"\",\n \"type\": \"string\",\n \"required\": false,\n \"computed\": false,\n \"choices\": [\n \"Website\",\n \"Personal\",\n \"Linkedin\",\n \"Twitter\",\n \"Other\"\n ]\n },\n {\n \"key\": \"date_created\",\n \"label\": \"Date Created\",\n \"placeholder\": \"2022-01-31T12:30:00\",\n \"type\": \"datetime\",\n \"required\": false,\n \"computed\": false\n }\n]"}],"_postman_id":"2fd2d984-3008-4010-8a2b-53af20527f06"},{"name":"Create Object Type","id":"c49dbae2-e91a-4651-8b79-5453858b5835","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Projects\",\n \"fields\": [\n {\n \"name\": \"awesome/text-field\",\n \"attributes\": { \"slug\": \"name\", \"label\": \"Name\" },\n \"children\": []\n }\n ],\n \"object_label_fields\": [\"name\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://{{team_slug}}.engineawesome.app/api/v1/object-types","description":"Creates an object type. Administrators and Owners can create object types, and your plan may limit how many you can have.
\nA default list layout is created for it automatically.
\nname: the plural name, such as Contacts. Up to 255 characters.content: the block markup of the object type's form, as returned by Object Type by ID.fields: every field, each {\"name\": \"<block type>\", \"attributes\": {...}, \"children\": []}. attributes.slug (letters, numbers, - and _, up to 40 characters, unique) and attributes.label (up to 40 characters) are required. Each field's other attributes are validated by its type.groups: field groups, each {\"attributes\": {\"slug\": \"...\", \"label\": \"...\"}, \"fields\": [\"<field slug>\", ...]}.object_label_fields: the field slugs that make up each object's label.notes: internal notes for app builders.content and fields describe the same form and should be sent together. The easiest way to get them right is to build the object type in the app and read it with Object Type by ID.
201 Created400: a field's name isn't a known field type.403: you aren't allowed to create object types, or your plan's limit is reached.422: a value is invalid, for example a duplicate field slug or an object_label_fields slug that isn't a field.Changes an object type. Send only the properties you want to change. Administrators and Owners can update object types.
\nobjectType: the object type's UUID.Accepts the same properties as Create Object Type.
\n\n\n⚠️
\nfieldsreplaces the whole list. A field you leave out is removed from the object type. Always read the object type first and send back every field, changed or not.
200 OK400: a field's name isn't a known field type.403: you aren't allowed to update object types.404: no object type with that ID exists on this team.422: a value is invalid.Deletes an object type. Its objects, views and forms stop appearing in the app and the API. Administrators and Owners can delete object types.
\nobjectType: the object type's UUID.204 No Content, with an empty body.403: you aren't allowed to delete object types.404: no object type with that ID exists on this team.In Engine Awesome, Object Types define the core data structure that can represent any real-world entity within the application. These object types allow users to categorize and organize data in a flexible, customizable way to fit their specific business needs. For example, Contacts, Projects, Tasks, and Donations are all object types within the system. Each object type serves as a template that users can customize by adding fields and attributes that are relevant to their workflows. This flexibility ensures that businesses can capture and manage the data they need, tailored specifically to their operations.
\n","_postman_id":"87c1990c-a39f-4977-920e-0562218546cc","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"52fadd8a-1a00-4a74-b816-ad8ffae0be7b","id":"52fadd8a-1a00-4a74-b816-ad8ffae0be7b","name":"Engine Awesome","type":"collection"}}},{"name":"Object","item":[{"name":"Object by ID","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","packages":{},"id":"ab86b639-4a07-444f-9782-8396b574190b"}}],"id":"6647f54f-56a9-4238-a8ec-4c46ceb4e7f6","protocolProfileBehavior":{"followRedirects":true,"disableUrlEncoding":false,"disableCookies":false,"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{team_slug}}.engineawesome.app/api/v1/objects/{{objectType}}/{{objectId}}","description":"Returns a single object, such as John Doe in Contacts, with every field you have permission to see.
\nobjectType: the object type's UUID.objectId: the object's _id._embed (optional): include related objects in the response instead of fetching each one separately. Pass relationship field slugs, comma separated, for example company,owner. Use a dotted path to embed the related object's own relationships, such as property.account (up to 3 levels deep), or * for every relationship. Related objects you can't view are left out.This is a GET request and does not require a request body.
\nEvery object returned by the Object endpoints has the same shape:
\n_id: the object's ID, a 24-character hex string._is_new: true only for an object that has no values yet (every field empty or still at its default). New objects are hidden from lists and don't trigger webhooks._label: the object's display label, built from the object type's object_label_fields. Left out when the label would be empty._id._links.self[0]: the object's API path (href) and targetHints.allow, the methods you are allowed to use on it._links.alternate[0] and _links[\"awesome:view\"][0]: when a page is set up to display this object, the object's URL in the app and the ID of that view._embedded: only when you pass _embed. Holds the related objects, keyed by relationship field slug._deleted_at, _created_at, _created_by: only on objects in the trash.Objects do not include an updated timestamp.
\n403: you don't have permission to view this object.404: the object type or object doesn't exist on this team.Optional. Relationship field slugs to include under _embedded, comma separated. Use dots to go deeper (up to 3 levels), or * for every relationship.
\n","type":"text/plain"},"key":"_embed","value":"company"}],"variable":[]}},"response":[{"id":"e19debf6-57de-45f6-8c2d-e5e73c5aa53b","name":"Object by ID","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dundermifflin.engineawesome.app/api/v1/objects/aef3b3cc-31c1-40f5-8ab6-bdb3d8bb47f5/67a279056c513a164e0ca94e"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"server","value":"nginx"},{"key":"content-type","value":"application/json"},{"key":"vary","value":"Accept-Encoding,Origin"},{"key":"cache-control","value":"no-cache, private"},{"key":"date","value":"Sun, 09 Feb 2025 03:09:39 GMT"},{"key":"x-ratelimit-limit","value":"600"},{"key":"x-ratelimit-remaining","value":"599"},{"key":"server-timing","value":"bootstrap;desc=\"Bootstrap\";dur=16.95704460144, database;desc=\"Database\";dur=33.77, app;desc=\"App\";dur=55, total;desc=\"Total\";dur=72.088956832886,"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"x-content-type-options","value":"nosniff"},{"key":"content-encoding","value":"gzip"},{"key":"transfer-encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"_id\": \"67a279056c513a164e0ca94e\",\n \"_is_new\": false,\n \"_label\": \"Steve Bruner\",\n \"first_name\": \"Steve\",\n \"last_name\": \"Bruner\",\n \"followup_date\": \"2025-05-17T20:40:21.000000Z\",\n \"followup_note\": \"Check in and followup\",\n \"mobile_phone\": null,\n \"office_phone\": \"+1 (718) 569-7188\",\n \"email\": \"sbruner@engineawesome.com\",\n \"company\": \"67a279056c513a164e0ca947\",\n \"notes\": null,\n \"type\": \"partner\",\n \"status\": \"New\",\n \"acquired\": \"Other\",\n \"date_created\": \"2024-12-09T18:49:00.000000Z\",\n \"_links\": {\n \"self\": [\n {\n \"href\": \"/api/v1/objects/aef3b3cc-31c1-40f5-8ab6-bdb3d8bb47f5/67a279056c513a164e0ca94e\",\n \"targetHints\": {\n \"allow\": [\n \"GET\",\n \"PUT\",\n \"DELETE\"\n ]\n }\n }\n ],\n \"alternate\": [\n {\n \"href\": \"https://dundermifflin.engineawesome.app/edit/object/aef3b3cc-31c1-40f5-8ab6-bdb3d8bb47f5/67a279056c513a164e0ca94e\",\n \"type\": \"text/html\"\n }\n ],\n \"awesome:view\": [\n {\n \"href\": \"/api/v1/views/a7ae3ce2-ff07-4b55-8e11-8bc5189c36cc\",\n \"id\": \"a7ae3ce2-ff07-4b55-8e11-8bc5189c36cc\"\n }\n ]\n }\n}"}],"_postman_id":"6647f54f-56a9-4238-a8ec-4c46ceb4e7f6"},{"name":"Object: search by field","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","packages":{},"id":"6a48fee6-ee7a-4798-9085-eba9294729d4"}}],"id":"e1d510c2-57b8-4add-924b-aea886e6fa0c","protocolProfileBehavior":{"followRedirects":true,"disableUrlEncoding":false,"disableCookies":false,"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{team_slug}}.engineawesome.app/api/v1/objects/{{objectType}}?{{field_slug}}={{field_value}}","description":"Returns a page of objects of one object type. With no query parameters it lists every object, newest first. Add query parameters to filter, search, sort and page through them.
\nPass any field marked \"Is Searchable\" as a query parameter, using its slug: ?email=john@example.com. Several field filters are combined with AND. GET Searchable Fields for Object Type lists the fields you can use.
IMPORTANT: a field that is not \"Is Searchable\", or a slug that doesn't exist, is ignored. If that is your only filter, the response contains every object.
\nHow the value matches depends on the field type:
\n?email=@acme.com matches every address at that domain.?followup_date=2025-05-17 matches that day. For a range, use ?followup_date[after]=2025-05-01&followup_date[before]=2025-05-31.?status[]=New&status[]=Followup to match any of them.+ for \"at least\" or - for \"at most\": ?amount=100+. Remember to URL-encode + as %2B.true or false._id.$$me for yourself, or $$unset for no user._search: free-text search on the fields that make up the object's label (the object type's object_label_fields). Matches if any of them contains the text.page: page number, starting at 1.per_page: objects per page. Default 10.order_by: a field slug to sort by. By default objects are sorted by the object type's \"created\" date field if it has one, otherwise by when they were created.order: asc or desc. Default desc._created_at[after], _created_at[before]: only objects created in this range. Any date format PHP understands, for example 2025-01-31 or 2025-01-31T12:00:00Z._updated_at[after], _updated_at[before]: only objects last updated in this range. Objects don't return an updated timestamp, but you can filter by it._created_by[]: only objects created by this user ID. Repeat it for several users.status=trash: list deleted objects instead. Requires permission to delete objects. Sorted by deletion time, and supports _deleted_at[after] and _deleted_at[before]._embed: include related objects. See Object by ID.To list the related objects of several parent objects in one request, pass _group_by with a relationship field slug, and the parent IDs under that slug. For example, every Contact at two Companies:
?_group_by=company&company[]=67a279056c513a164e0ca947&company[]=67a279056c513a164e0ca948
You can pass up to 100 parent IDs. The response is an object keyed by parent ID instead of an array. Each value has items (the objects), total and totalPages, and page and per_page apply to each group separately.
A JSON array of objects. Each has the shape described under Object by ID.
\nX-WP-Total: the total number of matching objects.X-WP-TotalPages: the number of pages.Link: rel=\"next\" and rel=\"prev\" URLs, when those pages exist.Allow: the methods you can use on this object type's collection, such as GET and POST.Objects you don't have permission to view are removed after the page is fetched. If permissions hide some objects, a page can contain fewer than per_page objects, and X-WP-Total still counts the hidden ones.
403: you don't have permission to view objects of this type, or to view the trash.422: a date or _created_by filter is not valid, or _group_by is not a relationship field.Filter by a searchable field. See the description for how each field type matches.
\n","type":"text/plain"},"key":"{{field_slug}}","value":"{{field_value}}"},{"disabled":true,"description":{"content":"Free-text search across the fields that make up the object label.
\n","type":"text/plain"},"key":"_search","value":"smith"},{"disabled":true,"description":{"content":"Page number, starting at 1.
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"Objects per page. Default 10.
\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"Field slug to sort by. Default: the \"created\" date field, or the creation time.
\n","type":"text/plain"},"key":"order_by","value":"{{field_slug}}"},{"disabled":true,"description":{"content":"asc or desc. Default desc.
\n","type":"text/plain"},"key":"order","value":"desc"},{"disabled":true,"description":{"content":"Only objects created on or after this date.
\n","type":"text/plain"},"key":"_created_at[after]","value":"2025-01-01"},{"disabled":true,"description":{"content":"Only objects created on or before this date.
\n","type":"text/plain"},"key":"_created_at[before]","value":"2025-12-31"},{"disabled":true,"description":{"content":"Only objects updated on or after this date.
\n","type":"text/plain"},"key":"_updated_at[after]","value":"2025-01-01"},{"disabled":true,"description":{"content":"Only objects updated on or before this date.
\n","type":"text/plain"},"key":"_updated_at[before]","value":"2025-12-31"},{"disabled":true,"description":{"content":"Only objects created by this user ID. Repeat for several users.
\n","type":"text/plain"},"key":"_created_by[]","value":"2"},{"disabled":true,"description":{"content":"List objects in the trash instead.
\n","type":"text/plain"},"key":"status","value":"trash"},{"disabled":true,"description":{"content":"Relationship field slugs to include under _embedded.
\n","type":"text/plain"},"key":"_embed","value":"company"}],"variable":[]}},"response":[{"id":"92ff2f88-6d47-4a35-9246-4f4506c8ddbe","name":"Object: search by field","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://dundermifflin.engineawesome.app/api/v1/objects/aef3b3cc-31c1-40f5-8ab6-bdb3d8bb47f5?last_name=bruner","protocol":"https","host":["dundermifflin","engineawesome","app"],"path":["api","v1","objects","aef3b3cc-31c1-40f5-8ab6-bdb3d8bb47f5"],"query":[{"key":"last_name","value":"bruner"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"server","value":"nginx"},{"key":"content-type","value":"application/json"},{"key":"vary","value":"Accept-Encoding,Origin"},{"key":"cache-control","value":"no-cache, private"},{"key":"date","value":"Fri, 07 Feb 2025 21:06:52 GMT"},{"key":"x-wp-total","value":"1"},{"key":"x-wp-totalpages","value":"1"},{"key":"allow","value":"GET"},{"key":"allow","value":"POST"},{"key":"x-ratelimit-limit","value":"600"},{"key":"x-ratelimit-remaining","value":"599"},{"key":"server-timing","value":"bootstrap;desc=\"Bootstrap\";dur=19.538164138794, database;desc=\"Database\";dur=62.48, app;desc=\"App\";dur=84, total;desc=\"Total\";dur=104.32314872742,"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"x-content-type-options","value":"nosniff"},{"key":"content-encoding","value":"gzip"},{"key":"transfer-encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"_id\": \"67a279056c513a164e0ca94e\",\n \"_is_new\": false,\n \"_label\": \"Steve Bruner\",\n \"first_name\": \"Steve\",\n \"last_name\": \"Bruner\",\n \"followup_date\": \"2025-05-17T20:40:21.000000Z\",\n \"followup_note\": \"Check in and followup\",\n \"mobile_phone\": null,\n \"office_phone\": \"+1 (718) 569-7188\",\n \"email\": \"sbruner@engineawesome.com\",\n \"company\": \"67a279056c513a164e0ca947\",\n \"notes\": null,\n \"type\": \"Partner\",\n \"status\": \"New\",\n \"acquired\": \"Other\",\n \"date_created\": \"2024-12-09T18:49:00.000000Z\",\n \"_links\": {\n \"self\": [\n {\n \"href\": \"/api/v1/objects/aef3b3cc-31c1-40f5-8ab6-bdb3d8bb47f5/67a279056c513a164e0ca94e\",\n \"targetHints\": {\n \"allow\": [\n \"GET\",\n \"PUT\",\n \"DELETE\"\n ]\n }\n }\n ],\n \"alternate\": [\n {\n \"href\": \"https://dundermifflin.engineawesome.app/edit/object/aef3b3cc-31c1-40f5-8ab6-bdb3d8bb47f5/67a279056c513a164e0ca94e\",\n \"type\": \"text/html\"\n }\n ],\n \"awesome:view\": [\n {\n \"href\": \"/api/v1/views/a7ae3ce2-ff07-4b55-8e11-8bc5189c36cc\",\n \"id\": \"a7ae3ce2-ff07-4b55-8e11-8bc5189c36cc\"\n }\n ]\n }\n }\n]"}],"_postman_id":"e1d510c2-57b8-4add-924b-aea886e6fa0c"},{"name":"Add Object","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","packages":{},"id":"27ed0f8a-4560-4d11-8789-ee9c484f839c"}}],"id":"9a9a6f44-b8e4-4354-92bc-d3c3c5bdea27","protocolProfileBehavior":{"followRedirects":true,"disableUrlEncoding":false,"disableCookies":false,"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"{{field_slug_to_PUT}}\": \"{{value_to_PUT}}\",\n \"{{another_field_slug_to_PUT}}\": \"{{another_value_to_PUT}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{team_slug}}.engineawesome.app/api/v1/objects/{{objectType}}","description":"Creates an object of the given object type. Send a JSON object of field values, keyed by field slug.
\nobjectType: the object type's UUID.{\n \"first_name\": \"John\",\n \"last_name\": \"James\",\n \"email\": \"john@james.com\",\n \"company\": \"67a279056c513a164e0ca947\"\n}\n_id.422.422._is_new: true, and required fields are not checked. This is what the app does when you click \"Add\", before anything is typed in. New objects don't appear in object lists and don't trigger object.created webhooks until they get a real value.201 CreatedCreating an object triggers your object.created webhooks.
403: you don't have permission to create objects of this type, or your team has reached its plan's object limit.404: the object type doesn't exist on this team.422: a value is not valid, or a required field has no value. The body has a message and an errors object keyed by field slug:{\n \"message\": \"The Email field is required.\",\n \"errors\": {\n \"email\": [\"The Email field is required.\"]\n }\n}\nUpdates an existing object. Send only the fields you want to change, keyed by field slug. Fields you leave out keep their current values.
\nFor example, to change a contact from a lead to a partner:
\n{\n \"type\": \"partner\"\n}\nobjectType: the object type's UUID.objectId: the object's _id.The same rules as Add Object:
\nAdditionally:
\n422 with \"The … field cannot be edited.\" Sending a locked field's current value is allowed.422. If a required field is empty and has a default value, the default is filled in.200 OKUpdating an object triggers your object.updated webhooks, with the changed fields in data.changes. If the object was still a new, empty object (_is_new: true), the first update that gives it a value triggers object.created instead.
403: you don't have permission to update this object.404: the object type or object doesn't exist on this team.422: a value is not valid, a locked field was changed, or a required field has no value. Same format as Add Object.Moves an object to the trash. It disappears from object lists and can't be fetched by ID, but you can list it with status=trash and bring it back with Restore Objects. To delete it for good, use Permanently Delete Objects.
You need permission to delete objects.
\nobjectType: the object type's UUID.objectId: the object's _id.204 No Content, with an empty body.Deleting an object triggers your object.deleted webhooks. Their payload has data.object (the deleted object), data.objectId and data.objectType.
403: you don't have permission to delete this object.404: the object type or object doesn't exist on this team, or the object is already in the trash.Takes one or more objects of an object type out of the trash.
\nYou need permission to delete objects.
\nobjectType: the object type's UUID.ids (required): an array of object _ids, at least one.IDs that aren't in this object type's trash are skipped without an error.
\n200 OKRestoring saves each object again, so it triggers your object.updated webhooks.
403: you don't have permission to restore one of the objects. Nothing is restored.422: ids is missing, empty or not an array.Permanently deletes one or more objects that are already in the trash. This can't be undone.
\nYou need permission to permanently delete objects. Being allowed to delete objects is not enough.
\nobjectType: the object type's UUID.ids (required): an array of object _ids, at least one.Only objects in the trash can be permanently deleted. Delete an object with Delete Object first. IDs that aren't in this object type's trash are skipped without an error.
\n204 No Content, with an empty body.403: you don't have permission to permanently delete one of the objects. Nothing is deleted.422: ids is missing, empty or not an array.In Engine Awesome, an Object is a specific record within an Object Type. For example, if you have an Object Type called Contacts, an Object might represent a specific person or entity, such as John Doe. Each Object holds data related to that specific instance, using the fields and attributes defined by its associated Object Type. Objects are the actual records you interact with when performing CRUD (Create, Read, Update, Delete) operations through the API.
\n","_postman_id":"e3ce8c6d-ab12-4aee-8a9c-e9cc49b5bd2b","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"52fadd8a-1a00-4a74-b816-ad8ffae0be7b","id":"52fadd8a-1a00-4a74-b816-ad8ffae0be7b","name":"Engine Awesome","type":"collection"}}},{"name":"Reports","item":[{"name":"Stat","id":"66d97956-5e2e-47f7-9159-1ea743a8b8d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{team_slug}}.engineawesome.app/api/v1/object-reports/{{objectType}}/stat?_operator=sum&_field={{field_slug}}","description":"Calculates a single number over the objects of an object type: how many there are, or the sum, average, minimum or maximum of a field.
\nYou need permission to view objects of this type.
\n_operator (required): count, sum, avg, min or max._field: the slug of the field to calculate, usually a number or money field. Required for every operator except count.Both report endpoints accept the same field filters and _search as List and Search Objects, so a report covers exactly the objects that list would return. New, empty objects and objects in the trash are never counted. The _created_at, _updated_at, _created_by and status parameters are not supported here.
{\n \"value\": \"12500.00\",\n \"formatted\": \"$12,500.00\"\n}\nvalue: the result, as a string. Money fields are in the currency's main unit (dollars, not cents).formatted: the result formatted the way the field displays it. Not included for count.403: you don't have permission to view objects of this type.422: _operator is missing or invalid, or _field is missing or isn't a field on the object type.count, sum, avg, min or max.
\n","type":"text/plain"},"key":"_operator","value":"sum"},{"description":{"content":"The number or money field to calculate. Not needed for count.
\n","type":"text/plain"},"key":"_field","value":"{{field_slug}}"},{"disabled":true,"description":{"content":"Optional field filter, as in List and Search Objects.
\n","type":"text/plain"},"key":"{{field_slug}}","value":"{{field_value}}"},{"disabled":true,"description":{"content":"Optional free-text search, as in List and Search Objects.
\n","type":"text/plain"},"key":"_search","value":"smith"}],"variable":[]}},"response":[{"id":"0ea8ae45-647e-44c2-bbe5-4e7a0babaa9f","name":"Stat","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://dundermifflin.engineawesome.app/api/v1/object-reports/aef3b3cc-31c1-40f5-8ab6-bdb3d8bb47f5/stat?_operator=count&status=New","protocol":"https","host":["dundermifflin","engineawesome","app"],"path":["api","v1","object-reports","aef3b3cc-31c1-40f5-8ab6-bdb3d8bb47f5","stat"],"query":[{"key":"_operator","value":"count"},{"key":"status","value":"New"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"server","value":"nginx"},{"key":"content-type","value":"application/json"},{"key":"cache-control","value":"no-cache, private"},{"key":"date","value":"Sun, 09 Feb 2025 03:30:00 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"value\": \"42\"\n}"}],"_postman_id":"66d97956-5e2e-47f7-9159-1ea743a8b8d7"},{"name":"Chart","id":"b621b223-bc28-466b-8a96-03c7619caf2c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{team_slug}}.engineawesome.app/api/v1/object-reports/{{objectType}}/chart?[after]=2025-01-01&[before]=2025-12-31","description":"Counts objects per hour, day or month over a date range, and can total number or money fields for each period too. This is the data behind the dashboard's chart block.
\nYou need permission to view objects of this type.
\nPass a range on one of the object type's searchable date fields, as you would to filter objects:
\n?close_date[after]=2025-01-01&close_date[before]=2025-12-31
Objects are grouped by that field. Without a range, objects are grouped by the object type's \"created\" date field (or by when they were created) and the range is the current month.
\nThe size of each period depends on the range:
\nAdd _series[0][sum]=<field slug> to also total that field for each period. Use _series[1][sum], _series[2][sum] and so on for more fields.
Both report endpoints accept the same field filters and _search as List and Search Objects, so a report covers exactly the objects that list would return. New, empty objects and objects in the trash are never counted. The _created_at, _updated_at, _created_by and status parameters are not supported here.
A JSON array with one entry for every period in the range, including periods with no objects:
\n[\n {\n \"_date\": \"2025-01-01T00:00:00+00:00\",\n \"_human\": \"Jan '25\",\n \"_count\": 14,\n \"amount\": { \"value\": \"8200.00\", \"formatted\": \"$8,200.00\" }\n }\n]\n_date: the start of the period (ISO 8601)._human: a short label for the period, for example 3 pm, Jan 5 or Jan '25._count: the number of objects in the period.value and formatted total.403: you don't have permission to view objects of this type.422: a _series entry has no sum, or sum isn't a field on the object type.Start of the date range, on a searchable date field.
\n","type":"text/plain"},"key":"[after]","value":"2025-01-01"},{"description":{"content":"End of the date range.
\n","type":"text/plain"},"key":"[before]","value":"2025-12-31"},{"disabled":true,"description":{"content":"Optional. Also total this field per period. Add _series[1][sum] and so on for more.
\n","type":"text/plain"},"key":"_series[0][sum]","value":"{{field_slug}}"},{"disabled":true,"description":{"content":"Optional free-text search, as in List and Search Objects.
\n","type":"text/plain"},"key":"_search","value":"smith"}],"variable":[]}},"response":[{"id":"684c5c9a-5790-4c73-b2df-ddc0482a10f5","name":"Chart","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://dundermifflin.engineawesome.app/api/v1/object-reports/aef3b3cc-31c1-40f5-8ab6-bdb3d8bb47f5/chart?date_created[after]=2025-01-01&date_created[before]=2025-01-07","protocol":"https","host":["dundermifflin","engineawesome","app"],"path":["api","v1","object-reports","aef3b3cc-31c1-40f5-8ab6-bdb3d8bb47f5","chart"],"query":[{"key":"date_created[after]","value":"2025-01-01"},{"key":"date_created[before]","value":"2025-01-07"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"server","value":"nginx"},{"key":"content-type","value":"application/json"},{"key":"cache-control","value":"no-cache, private"},{"key":"date","value":"Sun, 09 Feb 2025 03:30:00 GMT"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"_date\": \"2025-01-01T00:00:00+00:00\",\n \"_human\": \"Jan 1\",\n \"_count\": 3\n },\n {\n \"_date\": \"2025-01-02T00:00:00+00:00\",\n \"_human\": \"Jan 2\",\n \"_count\": 5\n },\n {\n \"_date\": \"2025-01-03T00:00:00+00:00\",\n \"_human\": \"Jan 3\",\n \"_count\": 0\n },\n {\n \"_date\": \"2025-01-04T00:00:00+00:00\",\n \"_human\": \"Jan 4\",\n \"_count\": 2\n },\n {\n \"_date\": \"2025-01-05T00:00:00+00:00\",\n \"_human\": \"Jan 5\",\n \"_count\": 7\n },\n {\n \"_date\": \"2025-01-06T00:00:00+00:00\",\n \"_human\": \"Jan 6\",\n \"_count\": 4\n },\n {\n \"_date\": \"2025-01-07T00:00:00+00:00\",\n \"_human\": \"Jan 7\",\n \"_count\": 1\n }\n]"}],"_postman_id":"b621b223-bc28-466b-8a96-03c7619caf2c"}],"id":"d8832376-36d6-4eed-8ab3-b5f202225710","description":"Calculate totals and time series over an object type's objects, as the dashboard's stat and chart blocks do.
\n","_postman_id":"d8832376-36d6-4eed-8ab3-b5f202225710","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"52fadd8a-1a00-4a74-b816-ad8ffae0be7b","id":"52fadd8a-1a00-4a74-b816-ad8ffae0be7b","name":"Engine Awesome","type":"collection"}}},{"name":"Views","item":[{"name":"List Views","id":"421f4a79-5665-49a7-9686-130d645047e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{team_slug}}.engineawesome.app/api/v1/views","description":"Returns your team's views that you are allowed to see, oldest first. Views for deleted object types are left out.
\nobject_type (optional): only views for this object type ID.A JSON array of views. Each has:
\nid: the view's UUID.type: item (the layout for a single object), collection (the layout for a list of objects), freeform (a page not tied to one object, such as a dashboard) or modal.name: the view's name.slug: its URL slug, or null.content: the view's block markup, for example <!-- wp:awesome/text {\"content\":\"Hello\"} /-->.parsedBlocks: the same blocks as a tree of {name, attributes, innerBlocks} objects. The app renders from parsedBlocks, not content.object_type: the object type it displays, or null for freeform views.parent: the ID of the view it is nested in, or null.visibility: for item layouts, which objects the layout is used for. visibility.isDefault (default true) marks the fallback layout, and visibility.fields holds field conditions.query: for collection views, the saved filters and sorting, or null.files: images and files the view uses, each {raw, rendered}. rendered is a signed URL valid for 7 days.created_at, updated_at: ISO 8601 timestamps._links.self[0]: the view's API path and the methods you can use on it.Allow: includes POST when you are allowed to create views.Only views for this object type.
\n","type":"text/plain"},"key":"object_type","value":"{{objectType}}"}],"variable":[]}},"response":[{"id":"279c88a9-9c63-4d36-840e-047ce76faa5e","name":"List Views","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://dundermifflin.engineawesome.app/api/v1/views","protocol":"https","host":["dundermifflin","engineawesome","app"],"path":["api","v1","views"],"query":[{"key":"object_type","value":"aef3b3cc-31c1-40f5-8ab6-bdb3d8bb47f5","description":"Only views for this object type.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"server","value":"nginx"},{"key":"content-type","value":"application/json"},{"key":"cache-control","value":"no-cache, private"},{"key":"date","value":"Sun, 09 Feb 2025 03:30:00 GMT"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"a7ae3ce2-ff07-4b55-8e11-8bc5189c36cc\",\n \"type\": \"item\",\n \"name\": \"Contact\",\n \"slug\": null,\n \"content\": \"\",\n \"parsedBlocks\": [\n {\n \"name\": \"awesome/text\",\n \"attributes\": {\n \"content\": \"Contact details\",\n \"visibility\": {\n \"fields\": []\n }\n },\n \"innerBlocks\": []\n }\n ],\n \"object_type\": \"aef3b3cc-31c1-40f5-8ab6-bdb3d8bb47f5\",\n \"parent\": null,\n \"visibility\": {\n \"isDefault\": true,\n \"fields\": []\n },\n \"query\": null,\n \"files\": [],\n \"created_at\": \"2023-04-02T00:16:18.000000Z\",\n \"updated_at\": \"2025-01-25T19:20:32.000000Z\",\n \"_links\": {\n \"self\": [\n {\n \"href\": \"/api/v1/views/a7ae3ce2-ff07-4b55-8e11-8bc5189c36cc\",\n \"targetHints\": {\n \"allow\": [\n \"GET\",\n \"PUT\",\n \"DELETE\"\n ]\n }\n }\n ]\n }\n },\n {\n \"id\": \"5e2d9a1b-3c4f-4a6e-8b7d-0f1e2d3c4b5a\",\n \"type\": \"collection\",\n \"name\": \"Contacts\",\n \"slug\": null,\n \"content\": \"\",\n \"parsedBlocks\": [],\n \"object_type\": \"aef3b3cc-31c1-40f5-8ab6-bdb3d8bb47f5\",\n \"parent\": null,\n \"visibility\": null,\n \"query\": {\n \"order_by\": \"date_created\",\n \"order\": \"desc\"\n },\n \"files\": [],\n \"created_at\": \"2023-04-02T00:16:18.000000Z\",\n \"updated_at\": \"2025-01-25T19:20:32.000000Z\",\n \"_links\": {\n \"self\": [\n {\n \"href\": \"/api/v1/views/5e2d9a1b-3c4f-4a6e-8b7d-0f1e2d3c4b5a\",\n \"targetHints\": {\n \"allow\": [\n \"GET\",\n \"PUT\",\n \"DELETE\"\n ]\n }\n }\n ]\n }\n }\n]"}],"_postman_id":"421f4a79-5665-49a7-9686-130d645047e9"},{"name":"Get View","id":"748c0d06-2258-4920-af02-ee1d37d3ec0e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{team_slug}}.engineawesome.app/api/v1/views/","description":"Returns one view by ID. An object's _links[\"awesome:view\"] gives the ID of the view used to display it.
viewId: the view's UUID.id: the view's UUID.type: item (the layout for a single object), collection (the layout for a list of objects), freeform (a page not tied to one object, such as a dashboard) or modal.name: the view's name.slug: its URL slug, or null.content: the view's block markup, for example <!-- wp:awesome/text {\"content\":\"Hello\"} /-->.parsedBlocks: the same blocks as a tree of {name, attributes, innerBlocks} objects. The app renders from parsedBlocks, not content.object_type: the object type it displays, or null for freeform views.parent: the ID of the view it is nested in, or null.visibility: for item layouts, which objects the layout is used for. visibility.isDefault (default true) marks the fallback layout, and visibility.fields holds field conditions.query: for collection views, the saved filters and sorting, or null.files: images and files the view uses, each {raw, rendered}. rendered is a signed URL valid for 7 days.created_at, updated_at: ISO 8601 timestamps._links.self[0]: the view's API path and the methods you can use on it.403: you aren't allowed to see this view.404: no view with that ID exists on this team.Creates a view. Administrators and Owners can create views.
\n{\n \"type\": \"freeform\",\n \"name\": \"Welcome\",\n \"content\": \"<!-- wp:awesome/text {\\\"content\\\":\\\"Hello\\\"} /-->\",\n \"parsedBlocks\": [\n { \"name\": \"awesome/text\", \"attributes\": { \"content\": \"Hello\" }, \"innerBlocks\": [] }\n ]\n}\ntype: item, collection, freeform or modal.name, slug (optional): slug must be unique.content and parsedBlocks: send both. They aren't generated from each other, and the app renders from parsedBlocks, so a view sent with only content shows up blank.object_type: the object type ID, for item and collection views.parent: the ID of a view to nest this one in.visibility, query: see Get View.files can't be set when creating a view. Add them with Update View.
201 Created403: you aren't allowed to create views.404: object_type or parent doesn't exist on this team.422: slug is already used.Changes a view. Send only the properties you want to change. Administrators and Owners can update views.
\nviewId: the view's UUID.Accepts the same properties as Create View, plus files:
content and parsedBlocks.object_type: send null to detach the view from its object type.files: the images and files the view uses, as [{\"raw\": \"<key>\"}], where each key comes from a file upload (see File Upload). Every image block in the view must have its file listed here, or it won't display.\n\n⚠️
\nfilesreplaces the whole list, and files you leave out are permanently deleted from storage. Always send every file the view still uses. Sending an empty list leaves the files unchanged.
200 OK403: you aren't allowed to update views.404: the view, or the object_type, doesn't exist on this team.422: slug is already used, or a file key doesn't belong to your team.Deletes a view. Administrators and Owners can delete views.
\nviewId: the view's UUID.204 No Content, with an empty body.403: you aren't allowed to delete views.404: no view with that ID exists on this team.Views are your app's pages and layouts: the layout used to show a single object, the list of an object type's objects, and freeform pages such as dashboards. They are built from blocks, the same way you build them in the app's editor.
\nCreating and editing views through the API is an advanced task. The easiest way to get the markup right is to build a view in the app and read it with Get View.
\n","_postman_id":"9ed7e8cd-b4b8-4c5c-8e88-7079a17fd4e5","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"52fadd8a-1a00-4a74-b816-ad8ffae0be7b","id":"52fadd8a-1a00-4a74-b816-ad8ffae0be7b","name":"Engine Awesome","type":"collection"}}},{"name":"Forms","item":[{"name":"List Forms","id":"4906adb7-7efa-42c4-b3b6-65baccb96095","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{team_slug}}.engineawesome.app/api/v1/forms","description":"Returns your team's forms that you are allowed to see, oldest first. Forms for deleted object types are left out.
\nobject_type (optional): only forms for this object type ID.A JSON array of forms. Each has:
\nid: the form's ID.title: the form's title.object_type: the object type that submissions create or update.created_by: the ID of the user who created it.fields: the form's blocks. Each field block is {\"name\": \"awesome/form-field\", \"attributes\": {\"field\": \"<field slug>\", ...}, \"children\": []}.content: the form's block markup.submitted_message: the message shown after someone submits the form.visibility: public (anyone with the link can submit it) or private.authorized_domains: if set, the public form only works on websites with these domains (and their subdomains).submission_behavior: what a submission does. See Update Form.submission_key_field: the field used to find an existing object, for behaviors that update.public_url: the form's public API URL. See Get Public Form.created_at, updated_at: ISO 8601 timestamps._links.self[0]: the form's API path and the methods you can use on it.Allow: includes POST when you are allowed to create forms.Only forms for this object type.
\n","type":"text/plain"},"key":"object_type","value":"{{objectType}}"}],"variable":[]}},"response":[{"id":"66022d7b-76d5-476f-a2e4-0a5d2593ea3b","name":"List Forms","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://dundermifflin.engineawesome.app/api/v1/forms","protocol":"https","host":["dundermifflin","engineawesome","app"],"path":["api","v1","forms"],"query":[{"key":"object_type","value":"aef3b3cc-31c1-40f5-8ab6-bdb3d8bb47f5","description":"Only forms for this object type.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"server","value":"nginx"},{"key":"content-type","value":"application/json"},{"key":"cache-control","value":"no-cache, private"},{"key":"date","value":"Sun, 09 Feb 2025 03:30:00 GMT"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"9b1f6c3e-4d2a-4f7e-8c55-2e7d1a0b6f41\",\n \"title\": \"Contact Us\",\n \"object_type\": \"aef3b3cc-31c1-40f5-8ab6-bdb3d8bb47f5\",\n \"created_by\": 2,\n \"fields\": [\n {\n \"name\": \"awesome/form-field\",\n \"attributes\": {\n \"field\": \"first_name\"\n },\n \"children\": []\n },\n {\n \"name\": \"awesome/form-field\",\n \"attributes\": {\n \"field\": \"email\"\n },\n \"children\": []\n }\n ],\n \"content\": \"\",\n \"submitted_message\": \"Thanks, we will be in touch.\",\n \"visibility\": \"public\",\n \"authorized_domains\": [],\n \"submission_behavior\": \"create\",\n \"submission_key_field\": null,\n \"public_url\": \"https://dundermifflin.engineawesome.app/api/v1/public/forms/9b1f6c3e-4d2a-4f7e-8c55-2e7d1a0b6f41\",\n \"created_at\": \"2025-02-09T03:30:00.000000Z\",\n \"updated_at\": \"2025-02-09T03:30:00.000000Z\",\n \"_links\": {\n \"self\": [\n {\n \"href\": \"/api/v1/forms/9b1f6c3e-4d2a-4f7e-8c55-2e7d1a0b6f41\",\n \"targetHints\": {\n \"allow\": [\n \"GET\",\n \"PUT\",\n \"PATCH\",\n \"DELETE\"\n ]\n }\n }\n ]\n }\n }\n]"}],"_postman_id":"4906adb7-7efa-42c4-b3b6-65baccb96095"},{"name":"Get Form","id":"6a141863-20e4-4c83-ba9c-5e969b5e210d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{team_slug}}.engineawesome.app/api/v1/forms/","description":"Returns one form by ID.
\nformId: the form's ID.id: the form's ID.title: the form's title.object_type: the object type that submissions create or update.created_by: the ID of the user who created it.fields: the form's blocks. Each field block is {\"name\": \"awesome/form-field\", \"attributes\": {\"field\": \"<field slug>\", ...}, \"children\": []}.content: the form's block markup.submitted_message: the message shown after someone submits the form.visibility: public (anyone with the link can submit it) or private.authorized_domains: if set, the public form only works on websites with these domains (and their subdomains).submission_behavior: what a submission does. See Update Form.submission_key_field: the field used to find an existing object, for behaviors that update.public_url: the form's public API URL. See Get Public Form.created_at, updated_at: ISO 8601 timestamps._links.self[0]: the form's API path and the methods you can use on it.403: you aren't allowed to read forms.404: no form with that ID exists on this team.Creates a form for an object type. Administrators and Owners can create forms.
\ntitle (required): the form's title.object_type (required): the object type ID that submissions create objects of.fields: the form's blocks. Use {\"name\": \"awesome/form-field\", \"attributes\": {\"field\": \"<field slug>\"}} for each field to ask for. Every slug must be a field on the object type.visibility: public or private.submitted_message: the message to show after submitting.authorized_domains: domain names, such as example.com, the public form may be used from.content, submission_behavior and submission_key_field can't be set when creating a form. New forms create a new object for every submission. Use Update Form to change that.
201 Created403: you aren't allowed to create forms.422: a field is missing or invalid, or fields uses a slug that isn't on the object type.Changes a form. Send only the properties you want to change. PATCH works the same way. Administrators and Owners can update forms.
formId: the form's ID.Accepts title, fields, visibility, submitted_message and authorized_domains as in Create Form, plus:
content: the form's block markup.submission_behavior: what a submission does:create (default): always create a new object.update_or_create: update the object whose key field matches the submitted value, or create one if none does.update_existing: only update an existing object. If none matches, the submission fails with 404.find_or_create: use the existing object if one matches, without changing its fields, or create one if none does.submission_key_field: the field slug to match on, such as email. Required by every behavior except create. The match is exact.The object type can't be changed.
\n200 OK403: you aren't allowed to update forms.404: no form with that ID exists on this team.422: a value is invalid, or submission_key_field isn't a valid field.Deletes a form. Its public URL stops working. Objects it created are not affected. Administrators and Owners can delete forms.
\nformId: the form's ID.204 No Content, with an empty body.403: you aren't allowed to delete forms.404: no form with that ID exists on this team.Returns what you need to display a public form on your own website. No access token is needed.
\nformId: the form's ID. The form's public_url is this endpoint's URL.title: the form's title.object_type: the object type ID.fields: the fields to show, in order, with their labels, types and settings.Responses can be cached for up to an hour.
\n403: the form has authorized_domains, and the request's Origin header is missing or isn't one of them.404: the form doesn't exist or isn't public.Submits a public form, creating or updating an object as the form's submission_behavior says. No access token is needed. This is the request to send from your own website.
formId: the form's ID.The values for the form's fields, keyed by field slug:
\n{\n \"first_name\": \"Jane\",\n \"email\": \"jane@example.com\",\n \"_rel\": {\n \"company\": { \"name\": \"Acme\" }\n },\n \"cf-turnstile-response\": \"<token>\"\n}\n422._rel: values for the form's related-object sections, keyed by relationship field slug. Each creates or updates a related object, linked to the submitted one.cf-turnstile-response: required if your team has the Cloudflare Turnstile integration turned on. It's the token from the Turnstile widget.202 Accepted{\"submitted_message\": \"Thanks, we will be in touch.\"}Successful submissions count towards your plan's monthly form submission limit, and trigger object.created or object.updated webhooks.
10 submissions per minute from each IP address, and 100 per minute for each form. Above that you get 429 Too Many Requests.
403: the request's Origin isn't one of the form's authorized_domains.404: the form doesn't exist or isn't public, or the behavior is update_existing and no object matches the key field.422: a value is invalid, a field isn't on the form, the captcha failed, the form was submitted empty, or your team has reached its form submission limit.429: too many submissions.Forms let people outside your team create or update objects, for example a contact form on your website. Each form belongs to one object type and lists which of its fields to ask for.
\nAdministrators and Owners manage forms with the endpoints in this folder. To show a form on your own website and submit it, use Get Public Form and Submit Public Form. Those two don't need an access token.
\n","_postman_id":"dbcd5a8e-b2b5-4f10-ad99-d74cfbdc2393","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"52fadd8a-1a00-4a74-b816-ad8ffae0be7b","id":"52fadd8a-1a00-4a74-b816-ad8ffae0be7b","name":"Engine Awesome","type":"collection"}}},{"name":"File Upload","item":[{"name":"Step 1 – Get Pre-Signed Upload URL","event":[{"listen":"test","script":{"exec":["// Parse JSON response","let json = {};","try {"," json = pm.response.json();","} catch (e) {"," pm.test('Response is JSON', function () {"," pm.expect.fail('Response was not valid JSON');"," });","}","","// Store main values from response","pm.collectionVariables.set('upload_url', json.url || '');","pm.collectionVariables.set('upload_key', json.key || '');","pm.collectionVariables.set('preview_url', json.previewUrl || '');","","const headers = json.headers || {};","","// Individual headers (these are arrays in the response)","pm.collectionVariables.set("," 'upload_content_type',"," (headers['Content-Type'] && headers['Content-Type'][0]) || 'application/octet-stream'",");","","pm.collectionVariables.set("," 'upload_x_amz_acl',"," (headers['x-amz-acl'] && headers['x-amz-acl'][0]) || 'private'",");","","pm.collectionVariables.set("," 'upload_x_amz_meta_team',"," (headers['x-amz-meta-team'] && headers['x-amz-meta-team'][0]) || ''",");","","pm.collectionVariables.set("," 'upload_x_amz_meta_user',"," (headers['x-amz-meta-user'] && headers['x-amz-meta-user'][0]) || ''",");","","// ✅ NEW: store Host too","pm.collectionVariables.set("," 'upload_host',"," (headers['Host'] && headers['Host'][0]) || ''",");","","pm.test('Stored upload variables for next step', function () {"," pm.expect(pm.collectionVariables.get('upload_url')).to.exist;"," pm.expect(pm.collectionVariables.get('upload_key')).to.exist;","});"],"type":"text/javascript","packages":{},"requests":{},"id":"61c48494-c1fd-4fc4-a6c7-f599f66d4b79"}}],"id":"ff40d189-f5d4-4a58-9841-2925c9a12ace","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"type\": \"{{file_type}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{team_slug}}.engineawesome.app/api/v1/upload","description":"Reserves a storage location for one file and returns a URL you can upload it to for the next 5 minutes.
\nYou need permission to upload files: the Owner, Administrator, Manager and Update Only roles have it. Your email address must also be verified.
\ntype (required): the file's MIME type, for example image/jpeg or application/pdf. It decides the file's extension.url: the pre-signed URL. PUT the file to it in Step 2.key: the file's path in storage, for example teams/your-team/TkBweWluQ3lrrV6k49GXYSyvGwsneP.webp. Save this as the file field's value in Step 3.headers: the headers you must send with the upload in Step 2. Each value is an array with one string.previewUrl: a URL for reading the file once it is uploaded, valid for 8 hours.This request's test script saves these values as collection variables for Steps 2 and 3.
\n403: you don't have permission to upload files, or your email address isn't verified.422: type is missing or isn't a MIME type we recognise.This is the actual file upload.
\nImportant:
\nThis request goes directly to our S3-compatible storage, not to the actual Engine Awesome app.
\nYou must send all the headers returned from Step 1 (Host, x-amz-acl, x-amz-meta-team, x-amz-meta-user, Content-Type).
The body must be the file itself.
\nYou have 5 minutes to complete this step before the url has expired.
\nThis step tells Engine Awesome: \"Here's the file I just uploaded — attach it to this object.\"
\nSet the file field to the key from Step 1, just like any other field. This example creates a new object; to attach the file to an existing object, send the same body to Update Object instead.
{\n \"{{file_field_slug}}\": \"\"\n}\nYou can also send the value as {\"raw\": \"<key>\"}, the same shape the API returns.
teams/<your team>/). Otherwise you get 422 with \"You do not have permission to view this file.\"422 with \"Invalid file type.\"File fields are returned as an object:
\n\"file_field\": {\n \"raw\": \"teams/your-team/TkBweWluQ3lrrV6k49GXYSyvGwsneP.webp\",\n \"rendered\": \"https://cdn.engineawesome.app/teams/your-team/TkBweWluQ3lrrV6k49GXYSyvGwsneP.webp?X-Amz-...\"\n}\nraw: the key you saved.rendered: a signed URL for downloading the file. It expires after 8 hours, so fetch the object again for a fresh one rather than storing it.An empty file field is {\"raw\": \"\", \"rendered\": \"\"}.
Engine Awesome doesn’t store files directly. Instead, we give you a short-lived, pre-signed URL to our S3-compatible storage. You upload the file directly to storage using that URL, then tell Engine Awesome which file you uploaded.
\nThis approach is used because it’s secure, scalable, and efficient:
\nSecure – The URL expires quickly and only allows one upload, so your API key or user credentials are never exposed.
\nFast & scalable – Files go straight from the client to storage, keeping Engine Awesome’s servers light and responsive.
\nReliable – Large uploads bypass app timeouts and limits, using proven S3 infrastructure for storage and delivery.
\nIn short: Engine Awesome handles the logic and permissions, while storage handles the heavy lifting.
\n","_postman_id":"2d2e95d5-f851-440b-b5f7-6638be6a8fb7","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"52fadd8a-1a00-4a74-b816-ad8ffae0be7b","id":"52fadd8a-1a00-4a74-b816-ad8ffae0be7b","name":"Engine Awesome","type":"collection"}}},{"name":"Team Members","item":[{"name":"Add Team Member","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","packages":{},"id":"11756e97-9606-430d-8386-89ab9b4cb739"}}],"id":"687a42f6-57e8-405e-b5ec-547c8f16a291","protocolProfileBehavior":{"followRedirects":true,"disableUrlEncoding":false,"disableCookies":false,"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"role\": \"viewer\",\n\t\"email\": \"example@example.org\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{team_slug}}.engineawesome.app/api/v1/team-members","description":"Sends an email invitation to join your team. The person becomes a team member when they accept it, so this does not return a user.
\nOnly Owners can invite team members.
\n{\n \"email\": \"example@example.org\",\n \"role\": \"viewer\",\n \"app_role\": null\n}\nemail (required): the address to invite.role (required): the team role to give them. See below.app_role (optional): one of your app's custom roles.role must be one of these keys:
app_role is optional: the slug of one of your app's own custom roles, if it has any.
201 Created, with an empty body.403: you aren't allowed to manage team members.422: a field is missing or invalid, the person is already on the team, they already have a pending invitation, or your plan doesn't allow more than one user.Returns everyone on your team. Any team member can call it.
\nA JSON array. Each member has:
\nid: the user's ID (a number).name: their name.email, role, app_role: only included if you are allowed to manage team members (Owners). role is one of the keys listed under Add Team Member. app_role is null unless your app has custom roles._links.self[0].href: the member's API path, and targetHints.allow, the methods you can use on it._links.icon[0].href: their profile photo URL.Allow: includes POST when you are allowed to invite team members.Returns one team member by user ID. Any team member can call it.
\nmemberId: the user's ID, from List Team Members.The same properties as each item in List Team Members. email, role and app_role are only included for Owners.
404: no user with that ID is on this team.Changes a team member's role, app_role, or both. Nothing else about a user can be changed through this endpoint.
Only Owners can update team members.
\nmemberId: the user's ID.{\n \"role\": \"editor\"\n}\nrole (optional): one of the role keys listed under Add Team Member.app_role (optional): one of your app's custom role slugs.Leave out either one to keep its current value.
\n200 OK403: you aren't allowed to manage team members.404: no user with that ID is on this team.422: role or app_role isn't a valid value.Removes a user from your team. Their user account isn't deleted, and objects they created keep them as the creator.
\nOwners can remove any member. Any member can remove themselves, which leaves the team.
\nmemberId: the user's ID.204 No Content, with an empty body.403: you aren't allowed to manage team members, and the ID isn't your own.422: the user is the team's original owner, who can't be removed.Team members are users who have access to your Engine Awesome application. They can be assigned specific roles and permissions that define what actions they can perform within the system. To add team members, you can either use the Engine Awesome UI or utilize the available API endpoints to programmatically manage your team. This flexibility ensures that you can control user access and assign appropriate roles to maintain the security and efficiency of your organization’s operations.
\n","_postman_id":"94b2cb8a-1f53-4eb7-b2d1-84658ecd39d7","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"52fadd8a-1a00-4a74-b816-ad8ffae0be7b","id":"52fadd8a-1a00-4a74-b816-ad8ffae0be7b","name":"Engine Awesome","type":"collection"}}},{"name":"Webhooks","item":[{"name":"Create Webhook","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","packages":{},"id":"d0fb0f95-5cb9-4b2e-8c3c-02cc2f5667bb"}}],"id":"5e710721-d016-4731-91ba-933d28495752","protocolProfileBehavior":{"followRedirects":true,"disableUrlEncoding":false,"disableCookies":false,"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"url\": \"https://url_to_webhook.com\",\n\t\"topics\": [\n\t\t\"object.created\",\n\t\t\"object.updated\",\n\t\t\"object.deleted\"\n\t],\n\t\"filters\": {\n\t\t\"object.created\": {\n\t\t\t\"_objectType\": \"{{objectType}}\",\n\t\t\t\"priority\": \"High\"\n\t\t},\n\t\t\"object.updated\": {\n\t\t\t\"_objectType\": \"{{objectType}}\",\n\t\t\t\"priority\": \"High\",\n\t\t\t\"status\": \"Accepted\"\n\t\t},\n\t\t\"object.deleted\": {\n\t\t\t\"_objectType\": \"{{objectType}}\"\n\t\t}\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"https://{{team_slug}}.engineawesome.app/api/v1/webhooks","description":"Creates a webhook that sends events from your team to a URL you choose. Only Owners can create webhooks.
\nurl (required): where to send events. Must be a URL whose host resolves in DNS.topics (required): the events to send, at least one. See the folder description for the list.name, description (optional): labels for your own reference. A webhook needs a name to appear in the app's \"send to webhook\" menus (object.send and query.send).status (optional): active (the default), paused or stopped. Only active webhooks send events.filters (optional): only send events that match. See below.filters limits which events are sent. It's an object keyed by topic, and each topic's value is an object of conditions. Every condition must match for the event to be sent.
\"filters\": {\n \"object.created\": {\n \"_objectType\": \"aef3b3cc-31c1-40f5-8ab6-bdb3d8bb47f5\",\n \"priority\": \"High\"\n },\n \"object.deleted\": {\n \"_objectType\": \"aef3b3cc-31c1-40f5-8ab6-bdb3d8bb47f5\"\n }\n}\n_objectType: only send events for objects of this object type. The value is a single object type ID, not a list.+ for \"at least\" and - for \"at most\", as in \"100+\".true or false.object.deleted only supports _objectType. Any other condition on it stops it from firing.filters must be one of the webhook's topics. Topics without a filter send every event.\n\n⚠️ Each topic's conditions must be a JSON object, never an array. A body like
\n\"filters\": {\"object.created\": [\"aef3b3cc-…\"]}is accepted with200, but afterwards every save of an object on your team fails with a 500 error while the webhook is active. If this happens, set the webhook'sstatustopaused(or delete it) to restore saves, then send the filters in the correct format.
The API never returns filters, so you can't read back what you saved. Keep a copy of what you sent.
201 Createdsigning_key to verify deliveries.403: you aren't allowed to manage webhooks, or your plan doesn't allow more webhooks.422: a field is missing or invalid, or filters has a key that isn't in topics.Returns every webhook on your team. Only Owners can list webhooks.
\nsendable (optional): 1 to only return webhooks that can be sent to by hand: active, named, and subscribed to object.send or query.send.A JSON array of webhooks. Each has:
\nid: the webhook's ID.user: the ID of the user who created it. Deliveries are built with this user's permissions.name, description: your labels, or null.status: active, paused or stopped. A webhook is set to stopped automatically after 6 failed deliveries in a row.url: where events are sent.signing_key: the secret used to sign deliveries. See \"Verifying Deliveries\" in the folder description.topics: the events it sends.fail_count: failed deliveries since the last successful one.last_sent_at, last_failed_at: when the last delivery succeeded or failed, or null.created_at, updated_at, deleted_at: ISO 8601 timestamps._links.self[0]: the webhook's API path and the methods you can use on it.filters is not returned.
Allow: includes POST when you are allowed to create webhooks.Only return active webhooks with a name that subscribe to object.send or query.send.
\n","type":"text/plain"},"key":"sendable","value":"1"}],"variable":[]}},"response":[{"id":"95209d02-bbcb-405c-9076-aadfbc9badf3","name":"List Webhooks","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dundermifflin.engineawesome.app/api/v1/webhooks"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"server","value":"nginx"},{"key":"content-type","value":"application/json"},{"key":"vary","value":"Accept-Encoding,Origin"},{"key":"cache-control","value":"no-cache, private"},{"key":"date","value":"Sun, 09 Feb 2025 01:21:45 GMT"},{"key":"allow","value":"GET"},{"key":"allow","value":"POST"},{"key":"x-ratelimit-limit","value":"600"},{"key":"x-ratelimit-remaining","value":"594"},{"key":"server-timing","value":"bootstrap;desc=\"Bootstrap\";dur=16.968965530396, database;desc=\"Database\";dur=39.53, app;desc=\"App\";dur=55, total;desc=\"Total\";dur=72.580099105835,"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"x-content-type-options","value":"nosniff"},{"key":"content-encoding","value":"gzip"},{"key":"transfer-encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 59,\n \"user\": 2,\n \"name\": \"Webhook for another service\",\n \"description\": \"This webhook will send new events to another service.\",\n \"status\": \"active\",\n \"url\": \"https://url_to_webhook.com\",\n \"signing_key\": \"of5w1gcrpMvENByYCX1CdblIeabRpeMM\",\n \"topics\": [\n \"object.created\",\n \"object.updated\",\n \"object.send\",\n \"object.deleted\"\n ],\n \"fail_count\": 0,\n \"created_at\": \"2025-02-09T01:21:33.000000Z\",\n \"updated_at\": \"2025-02-09T01:21:33.000000Z\",\n \"last_sent_at\": null,\n \"last_failed_at\": null,\n \"deleted_at\": null,\n \"_links\": {\n \"self\": [\n {\n \"href\": \"/api/v1/webhooks/59\",\n \"targetHints\": {\n \"allow\": [\n \"GET\",\n \"PUT\",\n \"DELETE\"\n ]\n }\n }\n ]\n }\n }\n]"}],"_postman_id":"ede5c31e-4fc6-4ee0-a6df-f77aacfb6e0e"},{"name":"Get Webhook","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","packages":{},"id":"9fc6249e-ce22-4927-aa5f-50058af5b430"}}],"id":"d5766913-8ec0-4543-9305-367210b78c0a","protocolProfileBehavior":{"followRedirects":true,"disableUrlEncoding":false,"disableCookies":false,"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{team_slug}}.engineawesome.app/api/v1/webhooks/","description":"Returns one webhook by ID. Only Owners can view webhooks.
\nwebhookId: the webhook's ID.id: the webhook's ID.user: the ID of the user who created it. Deliveries are built with this user's permissions.name, description: your labels, or null.status: active, paused or stopped. A webhook is set to stopped automatically after 6 failed deliveries in a row.url: where events are sent.signing_key: the secret used to sign deliveries. See \"Verifying Deliveries\" in the folder description.topics: the events it sends.fail_count: failed deliveries since the last successful one.last_sent_at, last_failed_at: when the last delivery succeeded or failed, or null.created_at, updated_at, deleted_at: ISO 8601 timestamps._links.self[0]: the webhook's API path and the methods you can use on it.filters is not returned.
403: you aren't allowed to manage webhooks.404: no webhook with that ID exists on this team.Changes a webhook. Send only the properties you want to change: url, topics, name, description, status or filters. They accept the same values as in Create Webhook.
Only Owners can update webhooks.
\nwebhookId: the webhook's ID.To pause a webhook:
\n{\n \"status\": \"paused\"\n}\nTo turn a stopped webhook back on after fixing your endpoint, set status to active.
topics and filters replace the current values completely. They aren't merged.filters, also send topics. The filters are checked against the topics in the request, and leaving topics out returns a 500 error. To remove all filters, send \"filters\": {} together with topics.filters format. Each topic's conditions must be an object, never an array.200 OK403: you aren't allowed to manage webhooks.404: no webhook with that ID exists on this team.422: a value isn't valid, for example a status other than active, paused or stopped.Deletes a webhook so it stops sending events. Only Owners can delete webhooks.
\nTo stop events only for a while, update its status to paused instead.
webhookId: the webhook's ID.204 No Content, with an empty body.403: you aren't allowed to manage webhooks.404: no webhook with that ID exists on this team.Returns the webhooks that objects or queries can be sent to by hand: active webhooks with a name that subscribe to object.send or query.send. These are the webhooks the app shows in its \"send to webhook\" menus.
Unlike List Webhooks, any team member can call this, and it only returns each webhook's id, name and topics. No URLs or signing keys.
GET /api/v1/send-webhooks/{webhookId} returns a single one in the same format, or 404 if it isn't sendable.
[\n {\n \"id\": 77,\n \"name\": \"Email ticket to vendor\",\n \"topics\": [\"object.send\"]\n }\n]\nSends one object, or a list query, to a sendable webhook. This is what a \"send to webhook\" button in the app does.
\nwebhookId: a webhook from List Sendable Webhooks.To send an object (the webhook must subscribe to object.send):
{\n \"objectType\": \"aef3b3cc-31c1-40f5-8ab6-bdb3d8bb47f5\",\n \"objectId\": \"67a279056c513a164e0ca94e\"\n}\nTo send a query (the webhook must subscribe to query.send):
{\n \"objectType\": \"aef3b3cc-31c1-40f5-8ab6-bdb3d8bb47f5\",\n \"query\": { \"status\": \"New\" }\n}\nobjectType (required): the object type's UUID.objectId: the object to send. You need permission to update the object, not just view it.query: any JSON object. It is passed through to the webhook unchanged as data.query; Engine Awesome doesn't run it. You need permission to view objects of the type.The webhook receives the object.send or query.send payload described in the folder description, including data.user: who sent it.
The delivery happens during this request, so the response comes after your webhook endpoint has answered.
\n204 No Content, with an empty body.If the body has neither a matching objectId nor query for the webhook's topics, nothing is sent and you still get 204.
403: you don't have permission to update the object, or to view objects of the type.404: the webhook isn't sendable, or the object type or object doesn't exist on this team.422: objectType is missing or not a UUID.Webhooks allow third-party applications to monitor and respond to changes occurring within Engine Awesome in real time. By setting up a webhook, you can receive notifications when specific events happen, such as updates to objects or changes in system data. This allows external systems to stay in sync with your Engine Awesome application, enabling automated workflows, integrations, and timely responses to key changes.
\nOnly Owners can create, view, update and delete webhooks, and your plan may limit how many you can have.
\nobject.created: an object was created (or a new, empty object got its first value).object.updated: an object was updated or restored from the trash.object.deleted: an object was moved to the trash or permanently deleted.object.send: someone sent a single object to this webhook, using a \"send to webhook\" button in the app or Send to Webhook.query.send: someone sent a list query to this webhook.Each delivery is a POST with a JSON body:
{\n \"topic\": \"object.updated\",\n \"created\": \"2025-02-08T23:36:51+00:00\",\n \"data\": {\n \"object\": { \"_id\": \"67a279056c513a164e0ca94e\", \"first_name\": \"Steve\", \"...\": \"...\" },\n \"objectType\": { \"id\": \"aef3b3cc-31c1-40f5-8ab6-bdb3d8bb47f5\", \"name\": \"Contacts\" },\n \"changes\": { \"status\": \"New\" }\n }\n}\ndata.object has the shape described under Object by ID. It is built with the permissions of the user who created the webhook, so fields they can't view are left out.data.changes (object.updated only): the previous values of the fields that changed, keyed by field slug. The new values are in data.object.object.deleted also has data.objectId.object.send and query.send have data.user (the id, email and name of the person who sent it). query.send has data.query instead of data.object.Every delivery has an X-Webhook-Signature header: the HMAC-SHA256 of the raw request body, hex-encoded, using the webhook's signing_key as the key. Compute the same value and compare it to confirm the request came from Engine Awesome.
2xx status within 3 seconds.fail_count goes up and last_failed_at is set. A successful delivery resets fail_count to 0 and sets last_sent_at.status changes to stopped and it stops sending. Set it back to active once your endpoint is fixed.410 Gone, the webhook is deleted.Returns every access token that belongs to you (the user making the request), oldest first. You can't see other users' tokens.
\nThe token values themselves are never returned. You only see a token once, when you create it.
\nA JSON array of tokens. Each has:
\nid: the token's ID. The first part of the token, before the |, is also its ID.name: the token's name.abilities: what the token is allowed to do. See Create Token.last_used_at: when the token was last used, or null.created_at, updated_at: ISO 8601 timestamps.Creates an access token for your user. Use it as a bearer token: Authorization: Bearer <plaintext>.
Your email address must be verified, and at least one of your teams must be on a plan that includes API access.
\n{\n \"name\": \"My New Token\",\n \"abilities\": [\"object:read\", \"object-type:read\", \"view:read\"]\n}\nname (required): a name to recognise the token by.abilities (required): at least one ability. See below.A token can never do more than its user's team role allows. Its abilities restrict it further: a request is only allowed if the user's role and the token both have the permission. Valid abilities:
\nobject:read, object:create, object:update, object:delete, object:force-delete, uploadobject-type:read, object-type:create, object-type:update, object-type:delete, object-type:force-deleteview:read, view:create, view:update, view:delete, view:force-deleteform:read, form:create, form:update, form:delete, form:force-deletewebhook:read, webhook:create, webhook:update, webhook:delete, webhook:force-deleteintegration:read, integration:create, integration:update, integration:delete, integration:force-deleteteam:update, team:manage-members, team:manage-appearance, team:billing, team:importbackup:read, backup:create, backup:restore, audit-log:read, maintenance:enableA token belongs to a user, not a team. It works on every team the user belongs to, with the user's role on each team.
\n200 OKplaintext, the token itself. This is the only time plaintext is returned. Store it securely.403: your email address isn't verified, or none of your teams' plans include API access.422: name or abilities is missing, or an ability isn't valid.Returns one of your access tokens by ID. The token value itself is not returned.
\naccessTokenId: the token's ID.id: the token's ID. The first part of the token, before the |, is also its ID.name: the token's name.abilities: what the token is allowed to do. See Create Token.last_used_at: when the token was last used, or null.created_at, updated_at: ISO 8601 timestamps.403: the token belongs to another user.404: no token with that ID exists.Renames one of your access tokens or changes its abilities. The token value stays the same.
\naccessTokenId: the token's ID.name (optional): a new name.abilities (optional): the new list of abilities. It replaces the current list. See Create Token for valid values.200 OK403: the token belongs to another user.404: no token with that ID exists.422: abilities is empty, or an ability isn't valid.Revokes one of your access tokens. Requests that use it fail from then on.
\nYou can use a token to delete itself.
\naccessTokenId: the token's ID.204 No Content, with an empty body.403: the token belongs to another user.404: no token with that ID exists.Access tokens in Engine Awesome are used to authenticate and authorize external applications to interact with your account through the API. Each token grants specific permissions, referred to as abilities, which define what actions the application can perform within Engine Awesome (e.g., read, create, update, delete objects).
\nAccess tokens are typically used for integrations with third-party services, such as automation tools, CRMs, or custom applications, allowing them to communicate with Engine Awesome without exposing sensitive credentials.
\n","_postman_id":"480f821a-332e-4b22-bd06-8c784280deaa","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"52fadd8a-1a00-4a74-b816-ad8ffae0be7b","id":"52fadd8a-1a00-4a74-b816-ad8ffae0be7b","name":"Engine Awesome","type":"collection"}}},{"name":"My Information (Access Token Creator)","item":[{"name":"Me","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","packages":{},"id":"138b9c54-15d8-47ae-838d-b1c07b51faa0"}}],"id":"1ddce4b4-487c-4eb1-bb61-5e6144b1d6bf","protocolProfileBehavior":{"followRedirects":true,"disableUrlEncoding":false,"disableCookies":false,"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{team_slug}}.engineawesome.app/api/v1/me","description":"Returns the user the access token belongs to. Use it to check which user and email address a token acts as.
\nThis endpoint works even while the team is in maintenance mode.
\nid, name, emailemail_verified: whether the email address is verified. Some endpoints, such as uploads and creating tokens, need a verified address.preferences: the user's app preferences, as a JSON object. {} if none are set.chaport_id: used by the in-app support chat.created_at, updated_at: ISO 8601 timestamps._links.icon[0].href: the profile photo URL._links.alternate[0].href: the profile page in the app._links.logout[0].href: the app's logout URL.Returns the team whose subdomain you called, as seen by the current user.
\nname: the team's name.slug: the team's subdomain, as in https://{slug}.engineawesome.app.roles: your app's custom roles, each with name and slug, if it has any. These are the values app_role accepts on Team Members.role: your team role on this team, such as owner or editor. See Add Team Member for the list.maintenance.scopes: the areas currently in maintenance mode, or []. See Maintenance Mode.maintenance.enabled_by, maintenance.enabled_at: who turned maintenance mode on and when, or null._links.self[0]: this endpoint, with targetHints.allow showing whether you can update the team._links[\"awesome:dashboard\"][0].href: the team's dashboard in the app._links[\"awesome:api\"][0].href: the team's API base URL.Allow: includes PUT when you are allowed to update the team.Returns every team the current user belongs to. An access token works on all of them, so this tells you which team subdomains you can call.
\nNote: this endpoint is on the main domain, https://engineawesome.app, not on a team subdomain.
A JSON array of teams, each with the same properties as Get the Current Team. role is your role on that team.
Updates the user the access token belongs to. Only these properties can be changed:
\nnameemail: must be a valid email address.preferences: a JSON object. It replaces the current preferences completely.chaport_idAny other property you send, including id and password, is ignored. Passwords can't be changed through the API.
200 OK422: email isn't a valid address, or a property has the wrong type.The My Information section provides detailed information about the user who created the access token. This section allows you to retrieve and manage key details related to the user, including personal information and team-related settings.
\n","_postman_id":"2133ce1e-3e67-43ed-b0c8-16ec63eb2579","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"52fadd8a-1a00-4a74-b816-ad8ffae0be7b","id":"52fadd8a-1a00-4a74-b816-ad8ffae0be7b","name":"Engine Awesome","type":"collection"}}},{"name":"Themes","item":[{"name":"List Themes","id":"28f689de-cd4a-478d-8849-94f15c881543","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{team_slug}}.engineawesome.app/api/v1/themes","description":"Returns the themes you can choose for your app. Any team member can call it.
\nA JSON array. Each theme has:
\nslug: the theme's ID. Use it with Preview Theme.title: the theme's display name.palette: its colours, each with name, slug and color (a hex value).The current themes are lavender, marigold, navy, olive, velvet and whisper.
Returns the block editor settings and styles for a theme, as the app uses them to preview it. This is mostly useful for building your own preview. It doesn't change your app's theme.
\nAny team member can call it.
\nthemeName: a theme slug from List Themes. An unknown slug returns the default theme's settings.__experimentalFeatures: the block editor settings for the theme, such as colour palettes, font sizes and spacing.styles: the theme's stylesheets, as an array of objects that each have a css string.disableCustomSpacingSizes, alignWide: editor flags.In Engine Awesome, Themes control the visual appearance and styling of your application. The theme settings allow you to customize elements such as colors, fonts, and overall design to match your brand or desired look.
\n","_postman_id":"9471ea1f-c0f2-4038-9bba-dc87500d6f03","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"52fadd8a-1a00-4a74-b816-ad8ffae0be7b","id":"52fadd8a-1a00-4a74-b816-ad8ffae0be7b","name":"Engine Awesome","type":"collection"}}},{"name":"Maintenance Mode","item":[{"name":"Get Maintenance Mode","id":"f027086c-379b-40e4-bdb6-692369168f47","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{team_slug}}.engineawesome.app/api/v1/maintenance","description":"Returns whether maintenance mode is on, and for which scopes. Any team member can call it.
\nscopes: the areas in maintenance mode: any of app, forms and settings. [] when maintenance mode is off.enabled_by: the ID of the user who turned it on, or null.enabled_at: when it was turned on (ISO 8601), or null.Get the Current Team also includes this, under maintenance.
Puts one or more scopes into maintenance mode. Only Owners can do this.
\nCalling it while maintenance mode is already on replaces the scopes, and makes you the user who turned it on.
\nscopes (required): at least one of app, forms and settings. See the folder description for what each blocks.Status: 201 Created
Body: the new maintenance state:
\nscopes: the areas in maintenance mode: any of app, forms and settings. [] when maintenance mode is off.
enabled_by: the ID of the user who turned it on, or null.
enabled_at: when it was turned on (ISO 8601), or null.
403: you aren't allowed to turn on maintenance mode.422: scopes is missing, empty or has an unknown scope.Turns maintenance mode off for every scope.
\nOnly the user who turned maintenance mode on can turn it off. If you turn it on with an access token, keep that token until you turn it off.
\n200 OK{\"scopes\": [], \"enabled_by\": null, \"enabled_at\": null}403: you aren't the user who turned maintenance mode on.Maintenance mode temporarily blocks changes to parts of your team's app, for example while you run a large import or restructure your object types. Turn it on for one or more scopes:
\napp: blocks all requests to the Object endpoints, file uploads, reports, the Zapier fields endpoint and sending to webhooks. Reads are blocked too.forms: blocks the Forms endpoints.settings: blocks changes to object types, views, the team, appearance, team members, webhooks, integrations, backups and imports. GET requests still work.While a scope is in maintenance, blocked requests return 503 Service Unavailable with a Retry-After: 3600 header and this body, for everyone, including the user who turned it on:
{\n \"code\": \"maintenance_mode\",\n \"message\": \"This section is currently under maintenance. Please try again later.\",\n \"data\": {\n \"scopes\": [\"app\"],\n \"enabled_by\": 2,\n \"enabled_at\": \"2025-02-08T23:36:51+00:00\"\n }\n}\nThe Maintenance Mode endpoints themselves, and Get the Current User, always work.
\n","_postman_id":"cee1dc74-268b-44e4-af20-d4fc2b3aeef1","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"52fadd8a-1a00-4a74-b816-ad8ffae0be7b","id":"52fadd8a-1a00-4a74-b816-ad8ffae0be7b","name":"Engine Awesome","type":"collection"}}},{"name":"Usage and Audit Logs","item":[{"name":"Usage","id":"f1271144-820c-41c8-b1c4-5c5ad92f6cfb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{team_slug}}.engineawesome.app/api/v1/usage","description":"Returns how much of your plan's limits your team is using. Only the team's owner can call it.
\n{\n \"objects\": {\n \"current\": 1520,\n \"limit\": 10000,\n \"by_type\": [\n { \"id\": \"aef3b3cc-31c1-40f5-8ab6-bdb3d8bb47f5\", \"name\": \"Contacts\", \"count\": 1200 }\n ]\n },\n \"file_storage\": { \"current\": 52428800, \"limit\": 1024 },\n \"form_submissions\": { \"current\": 37, \"limit\": 500 }\n}\nobjects.current: the number of objects on the team. by_type breaks it down by object type, not counting new, empty objects.file_storage.current is in bytes, but file_storage.limit is in megabytes.form_submissions: public form submissions in the current billing period.limit of null means your plan has no limit.403: you aren't the team's owner.Returns a record of changes to objects on your team, newest first: who created, updated, deleted or restored which object, when, and from where.
\nOnly Owners can read audit logs, and only on plans that include them. On other plans this endpoint returns 404. How far back logs go depends on your plan.
search: an IP address or email address matches exactly. Any other text matches events whose object label contains it.event_type[]: created, updated, soft_deleted (moved to the trash), force_deleted (permanently deleted) or restored.object_type_id[], user_id[]: only events for these object types or by these users.ip_address: only events from IP addresses that contain this text.date_from, date_to: only events from the start of date_from to the end of date_to.page, per_page: pagination. per_page defaults to 20 and can't be more than 100.Repeat the [] parameters to pass several values.
Send Accept: text/csv instead of application/json to download every matching event as a CSV file, without pagination.
A JSON array of events. Each has:
\nid: the event's ID.event_type, event_type_label: what happened, as a key and as readable text.object_type_id, object_id, object_label: the object it happened to.user_id, user_name, user_email: who did it.ip_address, referrer: where the request came from.via_token: the name of the access token used, or null if the change was made in the app.form_id: the form, if it came from a public form submission.fields_edited: the slugs of the fields that were changed (for updates) or filled in (for creates).created_at: when it happened (ISO 8601).X-WP-Total, X-WP-TotalPages: the number of matching events and pages.Link: rel=\"next\" and rel=\"prev\" URLs, when those pages exist.403: you aren't allowed to read audit logs.404: your plan doesn't include audit logs.422: a filter isn't valid, for example an unknown event type or date_to before date_from.An IP address, an email address, or text in the object label.
\n","type":"text/plain"},"key":"search","value":"Steve"},{"disabled":true,"description":{"content":"created, updated, soft_deleted, force_deleted or restored. Repeat for several.
\n","type":"text/plain"},"key":"event_type[]","value":"updated"},{"disabled":true,"description":{"content":"Only events for this object type. Repeat for several.
\n","type":"text/plain"},"key":"object_type_id[]","value":"{{objectType}}"},{"disabled":true,"description":{"content":"Only events by this user. Repeat for several.
\n","type":"text/plain"},"key":"user_id[]","value":"2"},{"disabled":true,"description":{"content":"Only events from IP addresses containing this text.
\n","type":"text/plain"},"key":"ip_address","value":"203.0.113."},{"disabled":true,"description":{"content":"Only events on or after this day.
\n","type":"text/plain"},"key":"date_from","value":"2025-01-01"},{"disabled":true,"description":{"content":"Only events on or before this day.
\n","type":"text/plain"},"key":"date_to","value":"2025-01-31"},{"disabled":true,"description":{"content":"Page number.
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"Events per page. Default 20, maximum 100.
\n","type":"text/plain"},"key":"per_page","value":"20"}],"variable":[]}},"response":[{"id":"a5b5962f-628a-4b60-ad56-0f7d6d98975c","name":"Audit Logs","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://dundermifflin.engineawesome.app/api/v1/audit-logs","protocol":"https","host":["dundermifflin","engineawesome","app"],"path":["api","v1","audit-logs"],"query":[{"key":"search","value":"Steve","description":"An IP address, an email address, or text in the object label.","disabled":true},{"key":"event_type[]","value":"updated","description":"created, updated, soft_deleted, force_deleted or restored. Repeat for several.","disabled":true},{"key":"object_type_id[]","value":"aef3b3cc-31c1-40f5-8ab6-bdb3d8bb47f5","description":"Only events for this object type. Repeat for several.","disabled":true},{"key":"user_id[]","value":"2","description":"Only events by this user. Repeat for several.","disabled":true},{"key":"ip_address","value":"203.0.113.","description":"Only events from IP addresses containing this text.","disabled":true},{"key":"date_from","value":"2025-01-01","description":"Only events on or after this day.","disabled":true},{"key":"date_to","value":"2025-01-31","description":"Only events on or before this day.","disabled":true},{"key":"page","value":"1","description":"Page number.","disabled":true},{"key":"per_page","value":"20","description":"Events per page. Default 20, maximum 100.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"server","value":"nginx"},{"key":"content-type","value":"application/json"},{"key":"cache-control","value":"no-cache, private"},{"key":"date","value":"Sun, 09 Feb 2025 03:30:00 GMT"},{"key":"x-wp-total","value":"2"},{"key":"x-wp-totalpages","value":"1"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"67a8233e9f1c2b0a4d5e6f71\",\n \"event_type\": \"updated\",\n \"event_type_label\": \"Updated\",\n \"object_type_id\": \"aef3b3cc-31c1-40f5-8ab6-bdb3d8bb47f5\",\n \"object_id\": \"67a279056c513a164e0ca94e\",\n \"object_label\": \"Steve Bruner\",\n \"user_id\": 2,\n \"user_name\": \"Steve Bruner\",\n \"user_email\": \"sbruner@engineawesome.com\",\n \"ip_address\": \"203.0.113.42\",\n \"fields_edited\": [\n \"type\"\n ],\n \"referrer\": null,\n \"via_token\": \"My New Token\",\n \"form_id\": null,\n \"created_at\": \"2025-02-09T03:12:30+00:00\"\n },\n {\n \"id\": \"67a1f0c29f1c2b0a4d5e6f70\",\n \"event_type\": \"created\",\n \"event_type_label\": \"Created\",\n \"object_type_id\": \"aef3b3cc-31c1-40f5-8ab6-bdb3d8bb47f5\",\n \"object_id\": \"67a279056c513a164e0ca94e\",\n \"object_label\": \"Steve Bruner\",\n \"user_id\": 2,\n \"user_name\": \"Steve Bruner\",\n \"user_email\": \"sbruner@engineawesome.com\",\n \"ip_address\": \"203.0.113.42\",\n \"fields_edited\": [\n \"first_name\",\n \"last_name\",\n \"email\",\n \"office_phone\",\n \"company\",\n \"type\",\n \"status\"\n ],\n \"referrer\": \"https://dundermifflin.engineawesome.app/\",\n \"via_token\": null,\n \"form_id\": null,\n \"created_at\": \"2025-02-04T20:31:01+00:00\"\n }\n]"}],"_postman_id":"7ee35fba-d9ee-4284-a378-24635d332b90"}],"id":"b6af78d1-f802-4bc5-8a94-0a0814f2444f","description":"Check how much of your plan your team is using, and who changed what.
\n","_postman_id":"b6af78d1-f802-4bc5-8a94-0a0814f2444f","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"52fadd8a-1a00-4a74-b816-ad8ffae0be7b","id":"52fadd8a-1a00-4a74-b816-ad8ffae0be7b","name":"Engine Awesome","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]}},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"172577e8-cc10-42b3-814b-e1235ca49907"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"2959d092-0783-4288-8990-9d5a03f07790"}}],"variable":[{"key":"upload_url","value":""},{"key":"upload_key","value":""},{"key":"preview_url","value":""},{"key":"upload_content_type","value":""},{"key":"upload_x_amz_acl","value":""},{"key":"upload_x_amz_meta_team","value":""},{"key":"upload_x_amz_meta_user","value":""},{"key":"upload_host","value":""},{"key":"webhookId","value":"","description":"A webhook ID, from List Webhooks."},{"key":"memberId","value":"","description":"A team member's user ID, from List Team Members."},{"key":"formId","value":"","description":"A form ID, from List Forms."},{"key":"viewId","value":"","description":"A view ID, from List Views."},{"key":"themeName","value":"","description":"A theme slug, such as navy, from List Themes."},{"key":"accessTokenId","value":"","description":"An access token ID, from List Your Access Tokens."},{"key":"date_field_slug","value":"","description":"The slug of a searchable date field, used by the Chart report."}]}