Search for sub-account
\n","urlObject":{"path":["v3","accounts",""],"host":["{{enterpriseURL}}"],"query":[],"variable":[]}},"response":[{"id":"e8c6b87f-76ed-4e79-b1cf-cb26afff7278","name":"No records found","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"url":"{{enterpriseURL}}/enterprise/v3/accounts/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 23 Aug 2019 22:25:20 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Content-Length","value":"115"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.15.6"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Vary","value":"Origin"},{"key":"X-Request-Id","value":"72104dc466f4edeeff38cd33e864970b"}],"cookie":[],"responseTime":null,"body":"{\n \"totalRecords\": 0,\n \"totalPages\": 0,\n \"records\": [],\n \"offset\": 0,\n \"limit\": 10,\n \"currentPage\": 1,\n \"previousPage\": 1,\n \"nextPage\": 2\n}"},{"id":"fc8edd72-7336-41e1-8d5c-b256d04146e8","name":"Valid Response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"url":"{{enterpriseURL}}/enterprise/v3/accounts/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 23 Aug 2019 22:23:49 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.15.6"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Request-Id","value":"a71ab55e67d754f5b340f6c37130f0b1"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"totalRecords\": 17,\n \"totalPages\": 2,\n \"records\": [\n {\n \"id\": 1000001,\n \"name\": \"Hacky Web\",\n \"apiKey\": \"01D5CSSRJ6FC1XYZ4EV\",\n \"maxApiRequests\": 100,\n \"organizationId\": 2\n },\n {\n \"id\": 1000003,\n \"name\": \"Portland\",\n \"apiKey\": \"01D7D8RYKJGVP6GJSNR\",\n \"maxApiRequests\": 100,\n \"organizationId\": 2,\n \"metadata\": [\n {\n \"key\": \"division\",\n \"value\": \"PTown\"\n },\n {\n \"key\": \"missionUnit\",\n \"value\": \"PT\"\n },\n {\n \"key\": \"areaName\",\n \"value\": \"Portland\"\n }\n ],\n \"createdAt\": \"2022-03-03T22:34:06Z\",\n \"updatedAt\": \"2022-03-22T17:37:39Z\"\n },\n {\n \"id\": 1000004,\n \"name\": \"Seattle Example\",\n \"apiKey\": \"01D7FTWKMZTJF353DXC\",\n \"maxApiRequests\": 100,\n \"organizationId\": 2,\n \"metadata\": [\n {\n \"key\": \"division\",\n \"value\": \"Northwestern\"\n },\n {\n \"key\": \"missionUnit\",\n \"value\": \"OH34\"\n },\n {\n \"key\": \"areaName\",\n \"value\": \"Seattle Example\"\n }\n ],\n \"createdAt\": \"2022-03-03T22:34:06Z\",\n \"updatedAt\": \"2022-03-22T17:37:39Z\"\n },\n {\n \"id\": 1000006,\n \"name\": \"Costa Mesa\",\n \"apiKey\": \"01D7Z30CBVNZ3771ET0\",\n \"maxApiRequests\": 100,\n \"organizationId\": 2,\n \"metadata\": [\n {\n \"key\": \"division\",\n \"value\": \"FLDWRK\"\n },\n {\n \"key\": \"missionUnit\",\n \"value\": \"ABC\"\n },\n {\n \"key\": \"areaName\",\n \"value\": \"Costa Mesa\"\n }\n ],\n \"createdAt\": \"2022-03-03T22:34:06Z\",\n \"updatedAt\": \"2022-03-22T17:37:39Z\"\n },\n {\n \"id\": 1000007,\n \"name\": \"Denver Example\",\n \"apiKey\": \"01D823537G75QG3C620\",\n \"maxApiRequests\": 100,\n \"organizationId\": 2,\n \"metadata\": [\n {\n \"key\": \"division\",\n \"value\": \"UA111\"\n },\n {\n \"key\": \"missionUnit\",\n \"value\": \"OH34\"\n },\n {\n \"key\": \"areaName\",\n \"value\": \"Denver Example\"\n }\n ],\n \"createdAt\": \"2022-03-03T22:34:06Z\",\n \"updatedAt\": \"2022-03-22T17:37:39Z\"\n },\n {\n \"id\": 1000008,\n \"name\": \"Sacramento\",\n \"apiKey\": \"01D84VBXKQENFK0Q8WS\",\n \"maxApiRequests\": 100,\n \"organizationId\": 2,\n \"metadata\": [\n {\n \"key\": \"division\",\n \"value\": \"UA321\"\n },\n {\n \"key\": \"missionUnit\",\n \"value\": \"OB34\"\n },\n {\n \"key\": \"areaName\",\n \"value\": \"Sacramento\"\n }\n ],\n \"createdAt\": \"2022-03-03T22:34:06Z\",\n \"updatedAt\": \"2022-03-22T17:37:39Z\"\n },\n {\n \"id\": 1000009,\n \"name\": \"San Diego\",\n \"apiKey\": \"01D86NG6PKADVEYKDPZ\",\n \"maxApiRequests\": 100,\n \"organizationId\": 2,\n \"metadata\": [\n {\n \"key\": \"division\",\n \"value\": \"UA111\"\n },\n {\n \"key\": \"missionUnit\",\n \"value\": \"MU\"\n },\n {\n \"key\": \"areaName\",\n \"value\": \"San Diego\"\n }\n ],\n \"createdAt\": \"2022-03-03T22:34:06Z\",\n \"updatedAt\": \"2022-03-22T17:37:39Z\"\n },\n {\n \"id\": 1000010,\n \"name\": \"San Diego\",\n \"apiKey\": \"01D877ZRZJN223N1JF1\",\n \"maxApiRequests\": 100,\n \"organizationId\": 2,\n \"metadata\": [\n {\n \"key\": \"division\",\n \"value\": \"Test\"\n },\n {\n \"key\": \"missionUnit\",\n \"value\": \"Test\"\n },\n {\n \"key\": \"areaName\",\n \"value\": \"San Diego\"\n }\n ],\n \"createdAt\": \"2022-03-03T22:34:06Z\",\n \"updatedAt\": \"2022-03-22T17:37:39Z\"\n },\n {\n \"id\": 1000011,\n \"name\": \"Austin\",\n \"apiKey\": \"01D8784P9YT8EQG7N96\",\n \"maxApiRequests\": 100,\n \"organizationId\": 2,\n \"metadata\": [\n {\n \"key\": \"division\",\n \"value\": \"Northwestern\"\n },\n {\n \"key\": \"missionUnit\",\n \"value\": \"OH34\"\n },\n {\n \"key\": \"areaName\",\n \"value\": \"Austin\"\n }\n ],\n \"createdAt\": \"2022-03-03T22:34:06Z\",\n \"updatedAt\": \"2022-03-22T17:37:39Z\"\n },\n {\n \"id\": 1000012,\n \"name\": \"Houston Metro\",\n \"apiKey\": \"01D8GZ77MRQV07259ZP\",\n \"maxApiRequests\": 100,\n \"organizationId\": 2,\n \"metadata\": [\n {\n \"key\": \"division\",\n \"value\": \"west\"\n },\n {\n \"key\": \"missionUnit\",\n \"value\": \"asdsads\"\n },\n {\n \"key\": \"areaName\",\n \"value\": \"Houston Metro\"\n }\n ],\n \"createdAt\": \"2022-03-03T22:34:06Z\",\n \"updatedAt\": \"2022-03-22T17:37:39Z\"\n }\n ],\n \"offset\": 0,\n \"limit\": 10,\n \"currentPage\": 1,\n \"previousPage\": 1,\n \"nextPage\": 2\n}"},{"id":"b80fb70b-da1a-4327-bc23-cd969f6665ee","name":"Search","originalRequest":{"method":"GET","header":[],"url":"{{enterpriseURL}}/v3/accounts/"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 17 May 2023 22:40:32 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Content-Length","value":"24"},{"key":"Connection","value":"close"},{"key":"Vary","value":"Origin"},{"key":"X-Request-Id","value":"25795507c7dc1a1871f828c79ae7b24c"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Not Found\"\n}"}],"_postman_id":"ed8d3eba-0bac-46ed-8d93-46b92ed4ecf1"},{"name":"Create account","id":"cb7fb977-a5b4-4266-a34f-a93fe48a05a3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{API_KEY}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Account Name\",\n \"subdomain\": \"accountname\",\n \"email\": \"test@test.com\",\n \"contactName\": \"Test Contact\",\n \"phone\": \"319-123-1233\",\n \"products\": [\n \t\"givingfuel.com\",\n \t\"regfox.com\",\n \t\"redpodium.com\",\n \t\"ticketspice.com\"\n ]\n}"},"url":"{{enterpriseURL}}/v3/accounts","urlObject":{"path":["v3","accounts"],"host":["{{enterpriseURL}}"],"query":[],"variable":[]}},"response":[{"id":"c416f8d6-e517-429b-9492-2a1c28f8d51c","name":"Create account","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Account Name\",\n \"subdomain\": \"accountname\",\n \"email\": \"test@test.com\",\n \"contactName\": \"Test Contact\",\n \"phone\": \"319-123-1233\",\n \"products\": [\n \t\"givingfuel.com\",\n \t\"regfox.com\",\n \t\"redpodium.com\",\n \t\"ticketspice.com\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{enterpriseURL}}/v3/accounts"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 26 Apr 2022 21:52:44 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Content-Length","value":"24"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.17.10"},{"key":"Vary","value":"Origin"},{"key":"X-Request-Id","value":"27719e6d045c79def0e165ee38c796a8"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Not Found\"\n}"}],"_postman_id":"cb7fb977-a5b4-4266-a34f-a93fe48a05a3"},{"name":"Get Account","id":"75adc6f7-5fc3-4078-b312-b32469988c95","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{API_KEY}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{enterpriseURL}}/v3/accounts/1000008","description":"Get an account by ID
\n","urlObject":{"path":["v3","accounts","1000008"],"host":["{{enterpriseURL}}"],"query":[{"disabled":true,"key":"key","value":"division"},{"disabled":true,"key":"value","value":"CO"},{"disabled":true,"key":"limit","value":"2"},{"disabled":true,"key":"page","value":"2"}],"variable":[]}},"response":[{"id":"5e06d382-3563-43ca-80cd-6298f82cc365","name":"Get Account (Success)","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{enterpriseURL}}/v3/accounts/1000008","host":["{{enterpriseURL}}"],"path":["v3","accounts","1000008"],"query":[{"key":"key","value":"division","disabled":true},{"key":"value","value":"CO","disabled":true},{"key":"limit","value":"2","disabled":true},{"key":"page","value":"2","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 09 Sep 2019 21:44:22 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Content-Length","value":"230"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.15.6"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Vary","value":"Origin"},{"key":"X-Request-Id","value":"f205e014cd51227bb5afa60724722dbf"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1000008,\n \"name\": \"Sacramento\",\n \"apiKey\": \"01D84VBXKQENFK0Q8WS\",\n \"maxApiRequests\": 100,\n \"metadata\": {\n \"metadataItems\": [\n {\n \"key\": \"division\",\n \"value\": \"UA321\"\n },\n {\n \"key\": \"missionUnit\",\n \"value\": \"OB34\"\n },\n {\n \"key\": \"areaName\",\n \"value\": \"Sacramento\"\n }\n ]\n },\n \"createdAt\": \"2022-03-03T22:34:06Z\",\n \"updatedAt\": \"2022-03-22T17:37:39Z\"\n}"}],"_postman_id":"75adc6f7-5fc3-4078-b312-b32469988c95"}],"id":"c3bf02b1-6cad-4307-92e7-7711a510d621","_postman_id":"c3bf02b1-6cad-4307-92e7-7711a510d621","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{API_KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e76e7a5d-2d82-4519-b478-77acf918196a","id":"e76e7a5d-2d82-4519-b478-77acf918196a","name":"Enterprise","type":"collection"}}},{"name":"Pages","item":[{"name":"P2P","item":[{"name":"Get","id":"a86b8bff-d059-4eea-ab1c-0b72fcb965a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{API_KEY}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{enterpriseURL}}/enterprise/v3/pages/1/supporter/1","urlObject":{"path":["enterprise","v3","pages","1","supporter","1"],"host":["{{enterpriseURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a86b8bff-d059-4eea-ab1c-0b72fcb965a8"},{"name":"Search","id":"178d48c3-3f4a-4ac0-a436-757ee063bcb3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{API_KEY}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"sort\": \"desc\",\n \"limit\": 100\n}","options":{"raw":{"language":"json"}}},"url":"{{enterpriseURL}}/enterprise/v3/pages/1/supporter/search","urlObject":{"path":["enterprise","v3","pages","1","supporter","search"],"host":["{{enterpriseURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"178d48c3-3f4a-4ac0-a436-757ee063bcb3"}],"id":"c0f662cd-dc55-4805-951f-f8b55760f8c9","description":"These endpoints are used for generating data on our Peer to Peer page supporters who have contributed towards different Peer to Peer pages.
\n","_postman_id":"c0f662cd-dc55-4805-951f-f8b55760f8c9","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{API_KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e76e7a5d-2d82-4519-b478-77acf918196a","id":"e76e7a5d-2d82-4519-b478-77acf918196a","name":"Enterprise","type":"collection"}}},{"name":"getPage","id":"61ac5561-67bf-48d5-a205-5223b4ee00bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{API_KEY}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"sort\": \"desc\",\n \"limit\": 100\n}","options":{"raw":{"language":"json"}}},"url":"{{enterpriseURL}}/enterprise/v3/pages/search","description":"id - Transaction ID (eq gt gte lt lte)
\"id\": [{\"value\": 123456, \"operator\": \"eq\"}]
accountId - Account ID
\n\"accountId\": 123456
type - (page template)
\"type\": \"page\"
name - Page Name
\n\"name\": \"My Page\"
status - (scheduled open closed archived deleted)
\"status\": \"open\"
product - (givingfuel.com redpodium.com regfox.com ticketspice.com)
\"product\": \"regfox.com\"
dateCreated - Date Transaction was created (eq gt gte lt lte)
\"dateCreated\": [{\"value\": \"2020-01-01T15:04:05Z\", \"operator\": \"eq\"}]
dateUpdated - Date Transaction was last updated (eq gt gte lt lte)
\"dateUpdated\": [{\"value\": \"2020-01-01T15:04:05Z\", \"operator\": \"eq\"}]
offset - The number in which to start finding records after. Default: 0
\n\"offset\": 100
limit - Limit returned results. Default: 100 | Max: 250
\n\"limit\": 100
sort - Sort IDs (asc desc)
\"sort\": \"asc\"
Create pages through enterprise API using template id.
\ntemplateId: (Required) ID of the template to be used
\naccountId:(Required) ID of the account to create the page in
name: (Required) Name of the event
gateways: Required for publish. Copied from template if not provided.
timezone: timezone of the event
metadata: metadata for the form
variables: keys and values to be used in variable interpolation for the template
eventStartDateTime: UTC date and time for the event start
eventEndDateTime: UTC date and time for the event end
registrationStartDateTime: UTC date and time for the registration start
registrationEndDateTime: UTC date and time for the registration end
Create pages through enterprise API using template id.
\ntemplateId: (Required) ID of the template to be used
\naccountId:(Required) ID of the account to create the page in
name: (Required) Name of the event
gateways: Required for publish. Copied from template if not provided.
timezone: timezone of the event
metadata: metadata for the form
variables: keys and values to be used in variable interpolation for the template
eventStartDateTime: UTC date and time for the event start
eventEndDateTime: UTC date and time for the event end
registrationStartDateTime: UTC date and time for the registration start
registrationEndDateTime: UTC date and time for the registration end
Get a Page by ID
\n","urlObject":{"path":["enterprise","v3","pages","1"],"host":["{{enterpriseURL}}"],"query":[],"variable":[]}},"response":[{"id":"932b9ad8-8ef1-4431-971a-09f22e7e0e90","name":"No records found","originalRequest":{"method":"GET","header":[],"url":"{{enterpriseURL}}/enterprise/v3/pages/1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 23 Aug 2019 22:25:20 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Content-Length","value":"115"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.15.6"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Vary","value":"Origin"},{"key":"X-Request-Id","value":"72104dc466f4edeeff38cd33e864970b"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"message\": \"Forbidden.\"\n }\n ],\n \"requestId\": \"77d0c033-900d-4fe0-98b7-a9800862ede9\"\n}"},{"id":"416efcdb-242a-4123-ab95-af9ddfd6debc","name":"Valid Response","originalRequest":{"method":"GET","header":[],"url":"{{enterpriseURL}}/enterprise/v3/pages/1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 23 Aug 2019 22:23:49 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.15.6"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Request-Id","value":"a71ab55e67d754f5b340f6c37130f0b1"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1,\n \"accountId\": 1,\n \"gateways\": [\n {\n \"id\": 1,\n \"label\": \"Wepay - Credit Card\"\n },\n {\n \"id\": 2,\n \"label\": \"Authnet - ACH\"\n }\n ],\n \"billingDisabled\": false,\n \"entityType\": \"page\",\n \"class\": \"form\",\n \"product\": \"regfox.com\",\n \"publishedPath\": \"my-account.regfox.com/our-test-page\",\n \"previewHash\": \"c12a1695a1ed49be88ab45b8a3a78ad9\",\n \"name\": \"Our Test Page\",\n \"timeZone\": \"America/Los_Angeles\",\n \"currency\": \"USD\",\n \"metadata\": {},\n \"eventStartDateTime\": \"2020-06-02T14:00:00Z\",\n \"eventEndDateTime\": \"2020-06-02T15:00:00Z\",\n \"registrationStartDateTime\": \"2020-05-01T15:04:05Z\",\n \"registrationEndDateTime\": \"2022-06-01T15:04:05Z\",\n \"fields\": {},\n \"design\": {},\n \"lastPublishedAt\": \"2022-03-18T18:11:57Z\",\n \"status\": \"OPEN\",\n \"createdAt\": \"2022-03-18T18:10:09Z\",\n \"updatedAt\": \"2022-05-23T19:13:30Z\"\n}"}],"_postman_id":"634d78ae-259a-49ed-9c3b-b22554d79842"},{"name":"Edit Page","id":"883efc15-5161-4ab1-9c0b-56bcf55fec45","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{API_KEY}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Test\",\n \"gateways\": [\n { \"id\": 1 },\n { \"id\": 2 }\n ],\n \"eventStartDateTime\": \"2020-06-02T14:00:00Z\",\n \"eventEndDateTime\": \"2020-06-02T15:00:00Z\",\n \"registrationStartDateTime\": \"2020-05-01T15:04:05Z\",\n \"registrationEndDateTime\": \"2022-06-01T15:04:05Z\",\n \"timezone\": \"America/Los_Angeles\",\n \"headerFields\": [\n {\n \"key\": \"banner\",\n \"value\": \"This is the first header\"\n },\n {\n \"key\": \"banner2\",\n \"value\": \"This is the second header\"\n }\n ]\n}"},"url":"{{enterpriseURL}}/enterprise/v3/pages/1","description":"Edit pages through enterprise API using template id.
\nname: Name of the page
timeZone: Time Zone of the event
eventStartDateTime: UTC date and time for the event start
eventEndDateTime: UTC date and time for the event end
registrationStartDateTime: UTC date and time for the registration start
registrationEndDateTime: UTC date and time for the registration end
headerFields: Array of key/value pairs for editing header banners. The value of the banner should be an HTML string
- `key`: A string representing the banner to be updated.\n- `value`: A string value containing the new banner HTML.\npageFields: Array of page fields to edit. Currently RegOptions is the only supported field. The value should be an \"options\" attribute with an array of \"options\"
- `key`: A string representing the registration option field to be updated.\n- `attributes`: An object containing information about the registration options.\n\n * `allowDeposit`: boolean - Whether or not a user can choose to use a deposit\n * `allowWaitlist`: boolean - Wheter or not a user can be waitlisted if inventory is exhausted\n * `amount`: string - The price of the registration option\n * `deductible`: string - The amount of the option that is tax deductible\n * `balanceDueDate`: date - When deposit full balance is due if deposit is selected.\n * `depositType`: string - \"percent\" or \"fixed\" determines how to apply the depositValue\n * `depositValue`: string - The deposit required for the option\n * `label`: string - The display text for the option\n * `description`: string - An optional for the option\n * `selected`: boolean - Determines if the option should be selected by default\n * `visible`: boolean - Determines if the option is visible\n * `limitedInventory`: boolean - Set to true if only a certain amount of the options exist\n * `inventory`: string - A numeric value representing the amount of options available\nPublish a page. \nThis can be used after creation or after an update of a page. In order to publish the page must have a gatewayId attached to it.
Also the path must be unique to the account/product.
\n","urlObject":{"path":["enterprise","v3","pages","1","publish"],"host":["{{enterpriseURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"65c9978b-aa1d-4d6d-96a8-1135be2df74f"},{"name":"Archive","id":"d340e3bc-dd24-4d89-9e6a-19119d3f38bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{API_KEY}}"}]},"isInherited":false},"method":"POST","header":[],"url":"{{enterpriseURL}}/enterprise/v3/pages/1/archive","description":"Archive a page. \nThis call will unpublished the page if it is published and move the form to archive. No data will be deleted, but the page will no long be available to accept registrations.
\n","urlObject":{"path":["enterprise","v3","pages","1","archive"],"host":["{{enterpriseURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d340e3bc-dd24-4d89-9e6a-19119d3f38bc"},{"name":"Restore","id":"5d33c943-c85a-4fa3-8fa0-138b12008def","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{API_KEY}}"}]},"isInherited":false},"method":"POST","header":[],"url":"{{enterpriseURL}}/enterprise/v3/pages/1/restore","description":"Restore an archived form. \nNote: This step will require a publish call if the form is to be made live again.
\n","urlObject":{"path":["enterprise","v3","pages","1","restore"],"host":["{{enterpriseURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5d33c943-c85a-4fa3-8fa0-138b12008def"}],"id":"ad36a455-b8db-4476-a849-9a7d8a5f1921","_postman_id":"ad36a455-b8db-4476-a849-9a7d8a5f1921","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{API_KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e76e7a5d-2d82-4519-b478-77acf918196a","id":"e76e7a5d-2d82-4519-b478-77acf918196a","name":"Enterprise","type":"collection"}}},{"name":"Registrants","item":[{"name":"Search","id":"524e0e0c-8a15-4f49-96a2-cf5f2666a984","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{API_KEY}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"sort\": \"desc\",\n \"limit\": 100\n}","options":{"raw":{"language":"json"}}},"url":"{{enterpriseURL}}/enterprise/v3/registrants/search","description":"id - Transaction ID (eq gt gte lt lte)
\n\"id\": [{\"value\": 123456, \"operator\": \"eq\"}]
accountId - Account ID
\n\"accountId\": 123456
status - (pending abandoned completed transferred canceled pending-offline pending-final pending-transfer waitlisted pre-registered)
\n\"status\": \"processing\"
product - (givingfuel.com redpodium.com regfox.com ticketspice.com)
\n\"product\": \"processing\"
pageID - Page ID
\n\"pageID\": 123456
contactID - Contact ID
\n\"contactID\": 123456
orderID - Order ID
\n\"orderID\": 123456
orderNumber - Order Number
\n\"orderNumber\": \"XYZ789\"
orderEmail - Order Number
\n\"orderEmail\": \"some.user@example.com\"
checkedIn - Date Checkin was created (eq gt gte lt lte)
\n\"checkedIn\": true/false
dateCheckedIn - Date CheckIn was created (eq gt gte lt lte)
\n\"dateCheckedIn\": [{\"value\": \"2020-01-01T15:04:05Z\", \"operator\": \"eq\"}]
dateCreated - Date Transaction was created (eq gt gte lt lte)
\n\"dateCreated\": [{\"value\": \"2020-01-01T15:04:05Z\", \"operator\": \"eq\"}]
dateUpdated - Date Transaction was last updated (eq gt gte lt lte)
\n\"dateUpdated\": [{\"value\": \"2020-01-01T15:04:05Z\", \"operator\": \"eq\"}]
offset - The number in which to start finding records after. Default: 0
\n\"offset\": 100
limit - Limit returned results. Default: 100 | Max: 250
\n\"limit\": 100
sort - Sort IDs \"asc\", \"desc\"
\n\"sort\": \"asc\"
Get a registrant by ID
\n","urlObject":{"path":["enterprise","v3","registrants","100"],"host":["{{enterpriseURL}}"],"query":[],"variable":[]}},"response":[{"id":"6449f334-7e68-4857-8a86-1f995aa6fa40","name":"Valid Response","originalRequest":{"method":"GET","header":[],"url":"{{enterpriseURL}}/enterprise/v3/registrants/59"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 23 Aug 2019 22:23:49 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.15.6"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Request-Id","value":"a71ab55e67d754f5b340f6c37130f0b1"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":" {\n \"id\": 1,\n \"accountId\": 1,\n \"page\": {\n \"id\": 1,\n \"billingDisabled\": false,\n \"product\": \"regfox.com\"\n },\n \"order\": {\n \"id\": 15,\n \"number\": \"TSTDSBLBLLNG-WB10019\",\n \"displayId\": \"01G0JEGMA5QBKAXE0HH\",\n \"email\": \"test@registrant.com\"\n },\n \"contact\": {\n \"id\": 4\n },\n \"displayId\": \"01G0JEGMANYK6A4JXJ0\",\n \"amount\": {\n \"amount\": 5300,\n \"currency\": \"USD\"\n },\n \"outstandingAmount\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"status\": \"completed\",\n \"fields\": [],\n \"checkedIn\": {\n \"status\": false\n },\n \"createdAt\": \"2022-04-13T21:50:46Z\",\n \"updatedAt\": \"2022-04-13T21:51:16Z\"\n }"},{"id":"7ad56812-b0ff-4066-8db7-ad2bf82166cf","name":"No records found","originalRequest":{"method":"GET","header":[],"url":"{{enterpriseURL}}/enterprise/v3/registrants/200"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 23 Aug 2019 22:25:20 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Content-Length","value":"115"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.15.6"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Vary","value":"Origin"},{"key":"X-Request-Id","value":"72104dc466f4edeeff38cd33e864970b"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"message\": \"Forbidden.\"\n }\n ],\n \"requestId\": \"5ae55421-aebf-4add-ba94-ebaab2fc14d4\"\n}"}],"_postman_id":"32bfcde7-fc82-4ef0-9cc2-2d18cdb1a689"},{"name":"Update","id":"f15ecba6-e609-448a-8b0d-2a0d608d5180","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{API_KEY}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"fields\": [\n\t\t{\n\t\t\t\"key\": \"keyfortextfield\",\n\t\t\t\"value\": \"StringValueGoesHere\"\n\t\t}, {\n\t\t\t\"key\": \"keyforcheckboxfield\",\n\t\t\t\"value\": true\n\t\t}\n\t]\n}"},"url":"{{enterpriseURL}}/enterprise/v3/registrants/100","description":"Update registrants TextField/Checkbox by ID
fields: (Required) An array of objects that contain a key and a value
NOTE:\nCheckbox values must be a bool\nRegOptions values must be a string.\nTextField values must be a string.
Adds a new payment to a registrant that is PendingFinalPayment
amount: The value in cents to apply to the registrant\npaymentMethod: same charge the card on file\n offline collect the payment outside the platform\n credit apply the value as creditnotes: Internal tracking of the payment\nmemo: Use for record information about offline payments
id - Transaction ID (eq gt gte lt lte)
\n\"id\": [{\"value\": 123456, \"operator\": \"eq\"}]
accountId - Account ID
\n\"accountId\": 123456
status - (pending abandoned completed transferred canceled pending-offline pending-final pending-transfer waitlisted pre-registered)
\n\"status\": \"processing\"
product - (givingfuel.com redpodium.com regfox.com ticketspice.com)
\n\"product\": \"processing\"
pageID - Page ID
\n\"pageID\": 123456
contactID - Contact ID
\n\"contactID\": 123456
orderID - Order ID
\n\"orderID\": 123456
orderNumber - Order Number
\n\"orderNumber\": \"XYZ789\"
orderEmail - Order Number
\n\"orderEmail\": \"some.user@example.com\"
checkedIn - Date Checkin was created (eq gt gte lt lte)
\n\"checkedIn\": true/false
dateCheckedIn - Date CheckIn was created (eq gt gte lt lte)
\n\"dateCheckedIn\": [{\"value\": \"2020-01-01T15:04:05Z\", \"operator\": \"eq\"}]
dateCreated - Date Transaction was created (eq gt gte lt lte)
\n\"dateCreated\": [{\"value\": \"2020-01-01T15:04:05Z\", \"operator\": \"eq\"}]
dateUpdated - Date Transaction was last updated (eq gt gte lt lte)
\n\"dateUpdated\": [{\"value\": \"2020-01-01T15:04:05Z\", \"operator\": \"eq\"}]
offset - The number in which to start finding records after. Default: 0
\n\"offset\": 100
limit - Limit returned results. Default: 100 | Max: 250
\n\"limit\": 100
sort - Sort IDs \"asc\", \"desc\"
\n\"sort\": \"asc\"
Get a registrant by ID
\n","urlObject":{"path":["enterprise","v3","tickets","100"],"host":["{{enterpriseURL}}"],"query":[],"variable":[]}},"response":[{"id":"c32c7c07-4c2f-42ca-bf02-bf079a9ec52a","name":"Valid Response","originalRequest":{"method":"GET","header":[],"url":"{{enterpriseURL}}/enterprise/v3/tickets/59"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 23 Aug 2019 22:23:49 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.15.6"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Request-Id","value":"a71ab55e67d754f5b340f6c37130f0b1"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":" {\n \"id\": 1,\n \"accountId\": 1,\n \"page\": {\n \"id\": 1,\n \"billingDisabled\": false,\n \"product\": \"regfox.com\"\n },\n \"order\": {\n \"id\": 15,\n \"number\": \"TSTDSBLBLLNG-WB10019\",\n \"displayId\": \"01G0JEGMA5QBKAXE0HH\",\n \"email\": \"test@registrant.com\"\n },\n \"contact\": {\n \"id\": 4\n },\n \"displayId\": \"01G0JEGMANYK6A4JXJ0\",\n \"amount\": {\n \"amount\": 5300,\n \"currency\": \"USD\"\n },\n \"outstandingAmount\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"status\": \"completed\",\n \"fields\": [],\n \"checkedIn\": {\n \"status\": false\n },\n \"createdAt\": \"2022-04-13T21:50:46Z\",\n \"updatedAt\": \"2022-04-13T21:51:16Z\"\n }"},{"id":"b5a3acc0-592d-4f73-a34a-c6fa5908f96a","name":"No records found","originalRequest":{"method":"GET","header":[],"url":"{{enterpriseURL}}/enterprise/v3/tickets/200"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 23 Aug 2019 22:25:20 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Content-Length","value":"115"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.15.6"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Vary","value":"Origin"},{"key":"X-Request-Id","value":"72104dc466f4edeeff38cd33e864970b"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"message\": \"Forbidden.\"\n }\n ],\n \"requestId\": \"5ae55421-aebf-4add-ba94-ebaab2fc14d4\"\n}"}],"_postman_id":"0c48fe3d-657e-4e90-bdf2-a24892526009"}],"id":"3c4118ff-75fd-40f0-8b74-d2d69a07e155","_postman_id":"3c4118ff-75fd-40f0-8b74-d2d69a07e155","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{API_KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e76e7a5d-2d82-4519-b478-77acf918196a","id":"e76e7a5d-2d82-4519-b478-77acf918196a","name":"Enterprise","type":"collection"}}},{"name":"Contacts","item":[{"name":"Search","id":"714c6188-c60e-4907-bf0d-a7537264d599","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{API_KEY}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"sort\": \"desc\",\n \"limit\": 100\n}","options":{"raw":{"language":"json"}}},"url":"{{enterpriseURL}}/enterprise/v3/contacts/search","description":"id - Transaction ID (eq gt gte lt lte)
\n\"id\": [{\"value\": 123456, \"operator\": \"eq\"}]
accountId - Account ID
\n\"accountId\": 123456
status - (pending abandoned completed transferred canceled pending-offline pending-final pending-transfer waitlisted pre-registered)
\n\"status\": \"processing\"
product - (givingfuel.com redpodium.com regfox.com ticketspice.com)
\n\"product\": \"processing\"
pageID - Page ID
\n\"pageID\": 123456
contactID - Contact ID
\n\"contactID\": 123456
orderID - Order ID
\n\"orderID\": 123456
orderNumber - Order Number
\n\"orderNumber\": \"XYZ789\"
orderEmail - Order Number
\n\"orderEmail\": \"some.user@example.com\"
checkedIn - Date Checkin was created (eq gt gte lt lte)
\n\"checkedIn\": true/false
dateCheckedIn - Date CheckIn was created (eq gt gte lt lte)
\n\"dateCheckedIn\": [{\"value\": \"2020-01-01T15:04:05Z\", \"operator\": \"eq\"}]
dateCreated - Date Transaction was created (eq gt gte lt lte)
\n\"dateCreated\": [{\"value\": \"2020-01-01T15:04:05Z\", \"operator\": \"eq\"}]
dateUpdated - Date Transaction was last updated (eq gt gte lt lte)
\n\"dateUpdated\": [{\"value\": \"2020-01-01T15:04:05Z\", \"operator\": \"eq\"}]
offset - The number in which to start finding records after. Default: 0
\n\"offset\": 100
limit - Limit returned results. Default: 100 | Max: 250
\n\"limit\": 100
sort - Sort IDs \"asc\", \"desc\"
\n\"sort\": \"asc\"
Get a registrant by ID
\n","urlObject":{"path":["enterprise","v3","contacts","100"],"host":["{{enterpriseURL}}"],"query":[],"variable":[]}},"response":[{"id":"63cc1e98-afe2-4d02-ada5-f882164c598a","name":"Valid Response","originalRequest":{"method":"GET","header":[],"url":"{{enterpriseURL}}/enterprise/v3/contacts/59"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 23 Aug 2019 22:23:49 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.15.6"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Request-Id","value":"a71ab55e67d754f5b340f6c37130f0b1"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":" {\n \"id\": 1,\n \"accountId\": 1,\n \"page\": {\n \"id\": 1,\n \"billingDisabled\": false,\n \"product\": \"regfox.com\"\n },\n \"order\": {\n \"id\": 15,\n \"number\": \"TSTDSBLBLLNG-WB10019\",\n \"displayId\": \"01G0JEGMA5QBKAXE0HH\",\n \"email\": \"test@registrant.com\"\n },\n \"contact\": {\n \"id\": 4\n },\n \"displayId\": \"01G0JEGMANYK6A4JXJ0\",\n \"amount\": {\n \"amount\": 5300,\n \"currency\": \"USD\"\n },\n \"outstandingAmount\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"status\": \"completed\",\n \"fields\": [],\n \"checkedIn\": {\n \"status\": false\n },\n \"createdAt\": \"2022-04-13T21:50:46Z\",\n \"updatedAt\": \"2022-04-13T21:51:16Z\"\n }"},{"id":"c37067c3-8b98-488d-ad34-8b5d6b5ff5b5","name":"No records found","originalRequest":{"method":"GET","header":[],"url":"{{enterpriseURL}}/enterprise/v3/contacts/200"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 23 Aug 2019 22:25:20 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Content-Length","value":"115"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.15.6"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Vary","value":"Origin"},{"key":"X-Request-Id","value":"72104dc466f4edeeff38cd33e864970b"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"message\": \"Forbidden.\"\n }\n ],\n \"requestId\": \"5ae55421-aebf-4add-ba94-ebaab2fc14d4\"\n}"}],"_postman_id":"0c6da725-1038-4e01-ad9b-e0bd29109635"}],"id":"0d2c25f8-3644-402d-92e4-2283b698297c","_postman_id":"0d2c25f8-3644-402d-92e4-2283b698297c","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{API_KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e76e7a5d-2d82-4519-b478-77acf918196a","id":"e76e7a5d-2d82-4519-b478-77acf918196a","name":"Enterprise","type":"collection"}}},{"name":"Hardstock Tickets","item":[{"name":"Search","id":"1871db89-b8de-4b38-8bb0-07ecff8519be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{API_KEY}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"sort\": \"desc\",\n \"limit\": 100\n}","options":{"raw":{"language":"json"}}},"url":"{{enterpriseURL}}/enterprise/v3/hardstock/search","description":"id - Transaction ID (eq gt gte lt lte)
\n\"id\": [{\"value\": 123456, \"operator\": \"eq\"}]
accountId - Account ID
\n\"accountId\": 123456
status - (pending abandoned completed transferred canceled pending-offline pending-final pending-transfer waitlisted pre-registered)
\n\"status\": \"processing\"
product - (givingfuel.com redpodium.com regfox.com ticketspice.com)
\n\"product\": \"processing\"
pageID - Page ID
\n\"pageID\": 123456
contactID - Contact ID
\n\"contactID\": 123456
orderID - Order ID
\n\"orderID\": 123456
orderNumber - Order Number
\n\"orderNumber\": \"XYZ789\"
orderEmail - Order Number
\n\"orderEmail\": \"some.user@example.com\"
checkedIn - Date Checkin was created (eq gt gte lt lte)
\n\"checkedIn\": true/false
dateCheckedIn - Date CheckIn was created (eq gt gte lt lte)
\n\"dateCheckedIn\": [{\"value\": \"2020-01-01T15:04:05Z\", \"operator\": \"eq\"}]
dateCreated - Date Transaction was created (eq gt gte lt lte)
\n\"dateCreated\": [{\"value\": \"2020-01-01T15:04:05Z\", \"operator\": \"eq\"}]
dateUpdated - Date Transaction was last updated (eq gt gte lt lte)
\n\"dateUpdated\": [{\"value\": \"2020-01-01T15:04:05Z\", \"operator\": \"eq\"}]
offset - The number in which to start finding records after. Default: 0
\n\"offset\": 100
limit - Limit returned results. Default: 100 | Max: 250
\n\"limit\": 100
sort - Sort IDs \"asc\", \"desc\"
\n\"sort\": \"asc\"
Get a registrant by ID
\n","urlObject":{"path":["enterprise","v3","hardstock","100"],"host":["{{enterpriseURL}}"],"query":[],"variable":[]}},"response":[{"id":"a057c63b-d287-4eff-b0eb-74ff2f9ae76d","name":"Valid Response","originalRequest":{"method":"GET","header":[],"url":"{{enterpriseURL}}/enterprise/v3/hardstock/59"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 23 Aug 2019 22:23:49 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.15.6"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Request-Id","value":"a71ab55e67d754f5b340f6c37130f0b1"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":" {\n \"id\": 1,\n \"accountId\": 1,\n \"page\": {\n \"id\": 1,\n \"billingDisabled\": false,\n \"product\": \"regfox.com\"\n },\n \"order\": {\n \"id\": 15,\n \"number\": \"TSTDSBLBLLNG-WB10019\",\n \"displayId\": \"01G0JEGMA5QBKAXE0HH\",\n \"email\": \"test@registrant.com\"\n },\n \"contact\": {\n \"id\": 4\n },\n \"displayId\": \"01G0JEGMANYK6A4JXJ0\",\n \"amount\": {\n \"amount\": 5300,\n \"currency\": \"USD\"\n },\n \"outstandingAmount\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"status\": \"completed\",\n \"fields\": [],\n \"checkedIn\": {\n \"status\": false\n },\n \"createdAt\": \"2022-04-13T21:50:46Z\",\n \"updatedAt\": \"2022-04-13T21:51:16Z\"\n }"},{"id":"e7281919-1da6-44e5-b992-88f88e023002","name":"No records found","originalRequest":{"method":"GET","header":[],"url":"{{enterpriseURL}}/enterprise/v3/hardstock/200"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 23 Aug 2019 22:25:20 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Content-Length","value":"115"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.15.6"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Vary","value":"Origin"},{"key":"X-Request-Id","value":"72104dc466f4edeeff38cd33e864970b"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"message\": \"Forbidden.\"\n }\n ],\n \"requestId\": \"5ae55421-aebf-4add-ba94-ebaab2fc14d4\"\n}"}],"_postman_id":"c1588596-27fe-4c12-b8e0-671767223775"}],"id":"f64d9541-f82b-47de-956d-8777f26ef060","_postman_id":"f64d9541-f82b-47de-956d-8777f26ef060","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{API_KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e76e7a5d-2d82-4519-b478-77acf918196a","id":"e76e7a5d-2d82-4519-b478-77acf918196a","name":"Enterprise","type":"collection"}}},{"name":"Orders","item":[{"name":"Lookup","id":"e8a85f86-2a01-460b-a410-f4aeac86a1c6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{API_KEY}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"sort\": \"desc\",\n \"limit\": 100,\n \"orderID\": 67419660,\n \"product\": \"givingfuel.com\"\n}","options":{"raw":{"language":"json"}}},"url":"{{enterpriseURL}}/enterprise/v3/orders/lookup?product=givingfuel.com&orderID=67419660","description":"id - Transaction ID (eq gt gte lt lte)
\n\"id\": [{\"value\": 123456, \"operator\": \"eq\"}]
accountId - Account ID
\n\"accountId\": 123456
status - (pending abandoned completed transferred canceled pending-offline pending-final pending-transfer waitlisted pre-registered)
\n\"status\": \"processing\"
product - (givingfuel.com redpodium.com regfox.com ticketspice.com)
\n\"product\": \"processing\"
pageID - Page ID
\n\"pageID\": 123456
contactID - Contact ID
\n\"contactID\": 123456
orderID - Order ID
\n\"orderID\": 123456
orderNumber - Order Number
\n\"orderNumber\": \"XYZ789\"
orderEmail - Order Number
\n\"orderEmail\": \"some.user@example.com\"
checkedIn - Date Checkin was created (eq gt gte lt lte)
\n\"checkedIn\": true/false
dateCheckedIn - Date CheckIn was created (eq gt gte lt lte)
\n\"dateCheckedIn\": [{\"value\": \"2020-01-01T15:04:05Z\", \"operator\": \"eq\"}]
dateCreated - Date Transaction was created (eq gt gte lt lte)
\n\"dateCreated\": [{\"value\": \"2020-01-01T15:04:05Z\", \"operator\": \"eq\"}]
dateUpdated - Date Transaction was last updated (eq gt gte lt lte)
\n\"dateUpdated\": [{\"value\": \"2020-01-01T15:04:05Z\", \"operator\": \"eq\"}]
offset - The number in which to start finding records after. Default: 0
\n\"offset\": 100
limit - Limit returned results. Default: 100 | Max: 250
\n\"limit\": 100
sort - Sort IDs \"asc\", \"desc\"
\n\"sort\": \"asc\"
Cancel an order. The cancellation is transactional and cascades to:
\ncancelRecurringDonations is true.Cancellable statuses for child rows: completed, pending offline, pending final payment, pending transfer. Rows already in cancelled are not touched.
Payment-plan subscriptions are intentionally excluded from the recurring cascade — they have their own cancel flow.
\nTransactions (payment records) are not touched. Refunds are a separate workflow.
\nAPI token via Authorization: Bearer {{API_KEY}}. Caller must have account scope on the order, or organization-master scope on the order's account.
This endpoint is not idempotent. Re-cancelling an already-cancelled order returns 422 Unprocessable Entity rather than a fresh 200 OK. Treat that as success-but-already-done at the call site if your client is replaying.
FOR UPDATE row lock. A payment processor completing one of these subscriptions concurrently with the cancel cannot have its newer state silently overwritten back to cancelled.cancelled, pending, abandoned, transferred, waitlisted, or pre-registered are left untouched.Order ID
\n","type":"text/plain"},"type":"any","value":"67419660","key":"id"}]}},"response":[{"id":"4fe30176-5a59-4b32-b629-ccafdaac1e79","name":"Cancelled — no recurring cascade","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"cancelRecurringDonations\": false\n}","options":{"raw":{"language":"json"}}},"url":"{{enterpriseURL}}/enterprise/v3/orders/67419660/cancel"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"orderId\": 67419660,\n \"status\": \"cancelled\",\n \"cancelledRecurringDonationIds\": [],\n \"cancelledTicketCount\": 0,\n \"cancelledRegistrantCount\": 1\n}"},{"id":"949bcaf7-3ab6-4aab-8e4a-5998f788f3c5","name":"Cancelled — with recurring donation cascade","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"cancelRecurringDonations\": true\n}","options":{"raw":{"language":"json"}}},"url":"{{enterpriseURL}}/enterprise/v3/orders/67419660/cancel"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"orderId\": 67419660,\n \"status\": \"cancelled\",\n \"cancelledRecurringDonationIds\": [101, 102],\n \"cancelledTicketCount\": 3,\n \"cancelledRegistrantCount\": 1\n}"},{"id":"2f9ab967-6534-48fb-ad27-5d926a196758","name":"Already cancelled","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"cancelRecurringDonations\": false\n}","options":{"raw":{"language":"json"}}},"url":"{{enterpriseURL}}/enterprise/v3/orders/67419660/cancel"},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": 422,\n \"message\": \"Unable to save record.\"\n }\n ]\n}"},{"id":"e60e5d7f-0c81-4da4-a2eb-9213053a3b54","name":"Forbidden — caller not in account scope","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"cancelRecurringDonations\": false\n}","options":{"raw":{"language":"json"}}},"url":"{{enterpriseURL}}/enterprise/v3/orders/67419660/cancel"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": 403,\n \"message\": \"Forbidden.\"\n }\n ]\n}"}],"_postman_id":"391da3e7-924a-4a81-b2ea-cc81cb5b0243"}],"id":"89dfea19-5dc2-4f3b-9b39-9b3fd8ca9121","_postman_id":"89dfea19-5dc2-4f3b-9b39-9b3fd8ca9121","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{API_KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e76e7a5d-2d82-4519-b478-77acf918196a","id":"e76e7a5d-2d82-4519-b478-77acf918196a","name":"Enterprise","type":"collection"}}},{"name":"Transactions","item":[{"name":"Search","id":"6257bdfa-26ae-4209-9ce3-65a2c27da0b3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{API_KEY}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"// {\n// \"sort\": \"desc\",\n// \"transactionType\": \"chargeback\",\n// \"limit\": 100\n// }\n\n{\n // \"offset\": 0,\n \"status\": \"completed\",\n \"batchId\": \"4260-2024-10-02\",\n \"transactionType\": \"chargeback\"\n // \"transactionType\": \"refund\"\n}","options":{"raw":{"language":"json"}}},"url":"{{enterpriseURL}}/enterprise/v3/transactions/search","description":"id - Transaction ID (eq gt gte lt lte)
\n\"id\": [{\"value\": 123456, \"operator\": \"eq\"}]
accountId - Account ID
\n\"accountId\": 123456
transactionType - (charge refund inventory-only voucher pre-authorize chargeback unknown)
\n\"transactionType\": \"charge\"
txReference - Transaction Reference
\n\"txReference\": \"ABC123\"
status - (processing pending-user pending-offline declined authorized completed voided voided-authorization canceled deleted gateway-error unknown)
\n\"status\": \"processing\"
product - (givingfuel.com redpodium.com regfox.com ticketspice.com)
\n\"product\": \"givingfuel.com\"
pageID - Page ID
\n\"pageID\": 123456
contactID - Contact ID
\n\"contactID\": 123456
orderID - Order ID
\n\"orderID\": 123456
orderNumber - Order Number
\n\"orderNumber\": \"XYZ789\"
orderEmail - Order Number
\n\"orderEmail\": \"some.user@example.com\"
batchId - Batch ID
\n\"batchId\": \"ABC123\"
amount - Order amount in cents (eq gt gte lt lte)
\n\"amount\": {\"value\": 1234, \"operator: \"eq\"}
dateCreated - Date Transaction was created (eq gt gte lt lte)
\n\"dateCreated\": [{\"value\": \"2020-01-01T15:04:05Z\", \"operator\": \"eq\"}]
dateUpdated - Date Transaction was last updated (eq gt gte lt lte)
\n\"dateUpdated\": [{\"value\": \"2020-01-01T15:04:05Z\", \"operator\": \"eq\"}]
offset - The number in which to start finding records after. Default: 0
\n\"offset\": 100
limit - Limit returned results. Default: 100 | Max: 250
\n\"limit\": 100
sort - Sort IDs \"asc\", \"desc\"
\n\"sort\": \"asc\"
Get a transaction by ID
\n","urlObject":{"path":["enterprise","v3","transactions","100"],"host":["{{enterpriseURL}}"],"query":[],"variable":[]}},"response":[{"id":"cb067b42-ff2e-4c4b-be25-bebe1b755566","name":"Valid Response","originalRequest":{"method":"GET","header":[],"url":"{{enterpriseURL}}/enterprise/v3/transactions/100"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 23 Aug 2019 22:23:49 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.15.6"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Request-Id","value":"a71ab55e67d754f5b340f6c37130f0b1"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 100,\n \"accountId\": 1000,\n \"page\": {\n \"id\": 1000,\n \"name\": \"Basic Page\",\n \"product\": \"regfox.com\"\n },\n \"contact\": {\n \"id\": 100\n },\n \"order\": {\n \"id\": 100,\n \"number\": \"BSCPG-WB10001\",\n \"displayId\": \"01FAEBTDB0GTK2YTNGH\",\n \"email\": \"johndoe@gmail.com\"\n },\n \"billing\": {\n \"email\": \"johndoe@gmail.com\",\n \"name\": {\n \"first\": \"John\",\n \"last\": \"Doe\"\n },\n \"address\": {\n \"street1\": \"123 Main St\",\n \"city\": \"Nowhere\",\n \"state\": \"AL\",\n \"postalCode\": \"12345\",\n \"country\": \"US\"\n }\n },\n \"transactionType\": \"charge\",\n \"amount\": {\n \"amount\": 5300,\n \"currency\": \"USD\"\n },\n \"deductible\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"paymentMethod\": \"card\",\n \"paymentType\": \"VISA\",\n \"paymentMask\": \"VISA-1111\",\n \"expirationMonth\": 3,\n \"expirationYear\": 2024,\n \"gatewayReference\": \"TESTERCHARGE\",\n \"gatewayMessage\": \"Tester Gateay - CHARGE\",\n \"status\": \"completed\",\n \"createdAt\": \"2021-07-12T22:01:23Z\",\n \"updatedAt\": \"2021-07-12T22:01:23Z\"\n }"},{"id":"42cef67b-a692-4a6d-ac16-d350ec9b5b61","name":"No records found","originalRequest":{"method":"GET","header":[],"url":"{{enterpriseURL}}/enterprise/v3/transactions/100"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 23 Aug 2019 22:25:20 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Content-Length","value":"115"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.15.6"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Vary","value":"Origin"},{"key":"X-Request-Id","value":"72104dc466f4edeeff38cd33e864970b"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"message\": \"Forbidden.\"\n }\n ],\n \"requestId\": \"361903bd-f1fc-43bb-a50d-afb89519b4f1\"\n}"}],"_postman_id":"59a451d7-9b80-4bf0-95ef-28ecee287b32"},{"name":"Void","id":"d0e93d15-787f-45f3-a1ed-2d1084c519d6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{API_KEY}}"}]},"isInherited":false},"method":"DELETE","header":[],"url":"{{enterpriseURL}}/enterprise/v3/transactions/100","description":"Void a transaction by ID
\n","urlObject":{"path":["enterprise","v3","transactions","100"],"host":["{{enterpriseURL}}"],"query":[],"variable":[]}},"response":[{"id":"0f891f65-1660-4ca3-9c9b-d5764afa30a1","name":"Valid Response","originalRequest":{"method":"DELETE","header":[],"url":"{{enterpriseURL}}/enterprise/v3/transactions/46234"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 23 Aug 2019 22:23:49 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.15.6"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Request-Id","value":"a71ab55e67d754f5b340f6c37130f0b1"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 100,\n \"accountId\": 1000,\n \"page\": {\n \"id\": 1000,\n \"name\": \"Basic Page\",\n \"product\": \"regfox.com\"\n },\n \"contact\": {\n \"id\": 100\n },\n \"order\": {\n \"id\": 100,\n \"number\": \"BSCPG-WB10001\",\n \"displayId\": \"01FAEBTDB0GTK2YTNGH\",\n \"email\": \"johndoe@gmail.com\"\n },\n \"billing\": {\n \"email\": \"johndoe@gmail.com\",\n \"name\": {\n \"first\": \"John\",\n \"last\": \"Doe\"\n },\n \"address\": {\n \"street1\": \"123 Main St\",\n \"city\": \"Nowhere\",\n \"state\": \"AL\",\n \"postalCode\": \"12345\",\n \"country\": \"US\"\n }\n },\n \"transactionType\": \"charge\",\n \"amount\": {\n \"amount\": 5300,\n \"currency\": \"USD\"\n },\n \"deductible\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"paymentMethod\": \"card\",\n \"paymentType\": \"VISA\",\n \"paymentMask\": \"VISA-1111\",\n \"expirationMonth\": 3,\n \"expirationYear\": 2024,\n \"gatewayReference\": \"TESTERCHARGE\",\n \"gatewayMessage\": \"Tester Gateay - CHARGE\",\n \"status\": \"voided\",\n \"createdAt\": \"2021-07-12T22:01:23Z\",\n \"updatedAt\": \"2021-07-12T22:01:23Z\"\n }"},{"id":"587f1385-be80-4048-b4f1-fe1ee888b22c","name":"No records found","originalRequest":{"method":"DELETE","header":[],"url":"{{enterpriseURL}}/enterprise/v3/transactions/46235"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 23 Aug 2019 22:25:20 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Content-Length","value":"115"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.15.6"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Vary","value":"Origin"},{"key":"X-Request-Id","value":"72104dc466f4edeeff38cd33e864970b"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"message\": \"Forbidden.\"\n }\n ],\n \"requestId\": \"361903bd-f1fc-43bb-a50d-afb89519b4f1\"\n}"}],"_postman_id":"d0e93d15-787f-45f3-a1ed-2d1084c519d6"}],"id":"f17449d2-9270-4a85-b6ed-106388a7ccd8","_postman_id":"f17449d2-9270-4a85-b6ed-106388a7ccd8","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{API_KEY}}"}]},"isInherited":true,"source":{"_postman_id":"e76e7a5d-2d82-4519-b478-77acf918196a","id":"e76e7a5d-2d82-4519-b478-77acf918196a","name":"Enterprise","type":"collection"}}},{"name":"Ping","id":"bddec8e1-6a7d-4503-91bd-399bb7226d75","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"{{enterpriseURL}}/enterprise/v3/ping","urlObject":{"path":["enterprise","v3","ping"],"host":["{{enterpriseURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"bddec8e1-6a7d-4503-91bd-399bb7226d75"}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{API_KEY}}"}]}},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"b51e0c55-5127-4494-918a-b28fbd960ddd"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"8c57d545-888c-4bf3-b71e-89026991bf72"}}]}