Spark is a sales, marketing, and customer relationship management platform designed specifically for the new development/pre-sale real estate industry.
\nFollow along with this documentation to learn about how to use the API and contact us at support@spark.re if you have any further questions.
\nThe Spark API is a RESTful interface, providing programmatic access to much of the data in the platform. It provides predictable URLs for accessing resources, and uses built-in HTTP features to receive requests and return responses.
\nKeep in mind that this documention assumes some basic understanding of how to work with APIs, including the requirement to percent/url encode all URLs before submitting requests.
\nSpark has a few publically accessible environments, while most of the time you'll want to work with the production environment, if you've been given access to to our demo environment (which is usually the case if you're testing/building a new integration), you'll need to prefix all of the domains with \"demo\".
\nFor example:
\nhttps://spark.re becomes https://demo.spark.re
https://app.spark.re becomes https://demo-app.spark.re
https://api.spark.re becomes https://demo-api.spark.re
Note: If you're using the Postman collection & environment, you only need to update the initial and current values, not the variable name. This allows you to easily switch between the demo and production environment.
\nData in Spark is stored and returned at 2 levels. You are able to create an API key at a company or project level, and depending on the which is submitted with the request, you will receive different data in return:
\nA company is a real estate developer, marketing firm, or brokerage using the Spark platform. All of our data is separated on a per company basis.
\nWhen accessing the API using a company API key, it will return data for all of the projects that belong to it.
\nA project is an indivdual real estate development, usually a single building that is being sold or leased. All projects belong to a single company, but a company can have multiple projects.
\nWhen accessing the API using a project API key, it will only return data for that project.
\nAll dates and times are returned following the ISO 8601 standard, in UTC (referred to as Z, meaning zero offset):
\n\"created_at\": \"2023-03-02T20:17:00Z\"
All monetary values are returned in cents:
\n\"purchase_price\": 142679200
Prices and other monetary values will need to be converted by moving the decimal place based on the currency you are working with.
\nFor example, to convert to a currency that has 2 decimal places, (like USD/CAD), divide the value by 100.
\nThe Spark API should only ever be accessed from the server side (aka backend) component of an application. Accessing the API from the client side (such as using javascript that is executed in a web browser) will expose the API key, and could allow access to all of the company and project data within Spark. You are responsible for connecting to the API, and storing credentials in a secure way.
\nSpark uses an HTTP token authorization for API access. An API key can be generated from a Spark account under Settings -> API. If you don't have access to Spark, ask your company contact to provide you with an account, or an API key with the correct permissions (see below).
\nAn authorization header should be submitted with all requests, in the following format:
\nAuthorization: Token token=\"•••••••\"
Note: The authorization header has been set on the top level of the Spark.re collection in Postman, and is inherited on all API requests automatically. There is no need to manually add it to each Postman request.
\nExample:
\ncurl --location 'https://api.spark.re/v2/contacts' \\\n --header 'Authorization: Token token=\"•••••••\"'\n\nWhen API keys are generated in Spark, they should be given the minimum required permissions to return only the data required for the integration.
\nIf an integration only requires access to read or write Contacts, please don't give access to read Inventory, Contracts, Reservations, Projects, etc.
\nNote: You don't need read permissions on data if you are only writing data. When a Create or Update request is sent, just as long as it was successful, you will get the result back in the response.
\nWhen a response from the API includes many results, Spark will paginate them and return a subset. By default, Spark will return 25 results per page.
\nFor example, GET /v2/contacts (Get Contacts) will only return 25 contacts even though the database can include many thousands of contacts. This makes the response quicker and easier to handle.
When a response is paginated, the response headers will include a Link header. The link header will be omitted if the endpoint does not support pagination or if all results fit on a single page. The link header contains URLs that you can used to fetch additional pages of results.
curl --location 'https://api.spark.re/v2/contacts'\n\nIf the response is paginated, the link header will look something like:
\nLink: <https://api.spark.re/v2/contacts?page=2>; rel=\"last\", <https://api.spark.re/v2/contacts?page=2>; rel=\"next\"
The link header provides the URL for the previous, next, first, and last page of results:
\nThe URL for the previous page is followed by rel=\"prev\".
The URL for the next page is followed by rel=\"next\".
The URL for the first page is followed by rel=\"first\".
The URL for the last page is followed by rel=\"last\".
In some cases, only a subset of these links are available. For example, the link to the previous page won't be included if you are on the first page of results, and the link to the last page won't be included if it can't be calculated.
\nYou can use the URLs from the link header to request another page of results. For example, to request the next page of results based on the previous example:
\ncurl --location 'https://api.spark.re/v2/contacts?page=2'\n\nMost endpoints accept a per_page query parameter to control how many results are returned on a page. The maximum results permitted per page is 100.
For example, this request submits the per_page query parameter to return five results per page:
curl --location 'https://api.spark.re/v2/contacts?per_page=5'\n\nWhen the per_page parameter is submitted, it will be included in the response link header:
Link: <https://api.spark.re/v2/contacts?page=2&per_page=5>; rel=\"last\", <https://api.spark.re/v2/contacts?page=2&per_page=5>; rel=\"next\"
When submitting a request that includes query parameters for filtering & ordering, the response link header will include them.
\nFor example, this request submits the first_name_cont query parameter to return contacts who's first name contains John:
curl --location 'https://api.spark.re/v2/contacts?first_name_cont=John'\n\nWhen the first_name_cont parameter is submitted, it will be included in the response link header:
Link: <https://api.spark.re/v2/contacts?page=2&first_name_cont=John>; rel=\"last\", <https://api.spark.re/v2/contacts?page=2&first_name_cont=John>; rel=\"next\"
When looking at the endpoints listed in this documentation, there will be query parameters listed (ending with _#) when that endpoint supports filters. The listed query parameters are meant to outline commonly used filters, however almost every field returned in the results can be used for filtering.
When using the listed query params, you simply need to replace the _# with one of the modifiers below. A few examples of this may be:
rating_value_# → rating_value_eq
city_# → city_start
first_name_# → first_name_cont
To use non listed filter, provide a field name (aka key) along with an modifier from the list below. The modifiers should added to the end of the field name.
\nFor example, looking at a partial contact object from the GET /v2/contacts (Get Contacts) request has email , first_name, andcreated_at fields.
{\n ~~~\n \"created_at\": \"2023-02-24T03:32:37Z\",\n \"date_of_birth\": null,\n \"email\": \"john@sparkreexample.com\",\n \"fax\": null,\n \"first_name\": \"John\",\n ~~~\n}\n\nTo filter the results you can pass the parameters in the following formats to achieve the result noted in the comments below:
\n// Email must exactly match john@sparkreexample.com\ncurl --location 'https://api.spark.re/v2/contacts?email_eq=john@sparkreexample.com'\n// First name must contain John\ncurl --location 'https://api.spark.re/v2/contacts?first_name_cont=John'\n// Contact was created on or after March 2nd\ncurl --location 'https://api.spark.re/v2/contacts?created_at_gteq=2023-03-02'\n\nThere may be cases where you want results that match multiple values for the same query parameter. All of the modifiers above (except _null and _not_null) can be used with an additional _any modifier.
When using the any modifier, you will need to submit the query parameter name (aka key) as an array, by appending [] to the end. A few examples of this may be:
rating_value_eq → rating_value_eq_any[]
city_eq → city_eq_any[]
first_name_cont → first_name_cont_any[]
Those filters in action:
\n// Has Hot or Warm rating\ncurl --location 'https://api.spark.re/v2/contacts?rating_value_eq_any[]=Hot&rating_value_eq_any[]=Warm'\n// Lives within New York or New Jersey\ncurl --location 'https://api.spark.re/v2/contacts?city_eq_any[]=New+York&city_eq_any[]=New+Jersey'\n// Has first name that contains John, Jane, or Jim\ncurl --location 'https://api.spark.re/v2/contacts?first_name_cont_any[]=John&first_name_cont_any[]=Jane&first_name_cont_any[]=Jim'\n\nMultiple query parameters can be separated by &, which then filters down the results further. Each query parameter is appened with AND, meaning the results will only match all of the filters requested.
For example, you can filter the results to only return Contacts with a first_name of John in the city of New York:
curl --location 'https://api.spark.re/v2/contacts?first_name_cont=John&city_eq=New+York'\n\nSee the example requests included in this documentation for additional examples of how to use the filters.
\nThere are query parameters on each endpoint that supports ordering (aka sorting). Most fields returned in the the results can be used for ordering. A direction can also be provided to change which results are returned first.
\nNote: The fields that are supported must be a direct child of a parent object that is returned, ordering based on nested fields is not currently supported. If you want to sort based on nested fields, make a request with the required order to those endpoints.
\nThe results are ordered by created_at by default. This in combination with a default decending direction means that the newest result will always be returned first, and the oldest last.
To order the results, submit the order query parameter along with the name of a field as the value.
// Order by id\ncurl --location 'https://api.spark.re/v2/contacts?order=id'\n// Order by last_name\ncurl --location 'https://api.spark.re/v2/contacts?order=last_name'\n// Order by registered_at\ncurl --location 'https://api.spark.re/v2/contacts?order=registered_at'\n\nThe results are ordered in decending (desc) order by default, which returns Z-A 9-0. You can also sort ascending (asc) which returns A-Z 0-9.
\nTo change the direction, submit the order, and direction query parameters.
// Order by id ascending\ncurl --location 'https://api.spark.re/v2/contacts?order=id&direction=asc'\n// Order by last_name ascending\ncurl --location 'https://api.spark.re/v2/contacts?order=last_name&direction=asc'\n// Order by registered_at descending\ncurl --location 'https://api.spark.re/v2/contacts?order=registered_at&direction=desc'\n\nQuerying for a list of records returns a limited dataset for all records. This includes model attributes and foreign keys. These records can be further refined with the use of filters.
\nQuerying for a single record returns the most complete dataset. All model attributes and associations are returned with their own attributes and foreign keys.
\nFor all create (via POST) or update (via PUT) requests, you will need to keep the following requirements in mind:
\nOur API only supports creating or updating data from a project api key. This means if you're working with a company api key, you will get an error when submitting the request. We will be supporting these request types from a company api key in the near future.
\nSpark accepts data for processing in JSON format. A header should be submitted with all create or update requests, in the following format:
\nContent-Type: application/json
Note: The content type header is set automatically in Postman as part of the request. The body is set to pass in raw text in JSON. There is no need to manually add it to each Postman request.
\nExample:
\ncurl --location 'https://api.spark.re/v2/contacts' \\\n --header 'Content-Type: application/json' \\\n --data-raw '{ \"email\": \"john@sparkreexample.com\" }'\n\nAll dates and times are accepted following the ISO 8601 standard. The following dates and times are all considered the same, and will be processed regardless of the format provided.
\nNote: If a date is submitted where a date and time is expected, the time will be set to 00:00.
\nDates & times in Spark are stored in UTC, so if a timezone is not specified, it will assume you've converted to UTC before submission. If a timezone is specified, Spark will adjust the time to UTC before saving the value.
\nIf the following datetime with a timezone offset of -8 (PST) is passed, when saved and returned in UTC it will have been adjusted to the next day.
\n2023-03-02T17:25:50-08:00 → 2023-03-03T01:25:50Z
For certain API integrations, it is highly recommend to use the ID endpoint (if available) instead of page location. Update (via PUT) requests that targets ID can reduce the likelihood of issues as page locations can change over time during a project's lifespan.
Responses from the Spark API will return one of the following status codes:
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Getting Started","slug":"getting-started"},{"content":"Environments","slug":"environments"},{"content":"Understanding the Data","slug":"understanding-the-data"},{"content":"Authorization","slug":"authorization"},{"content":"Pagination","slug":"pagination"},{"content":"Filtering","slug":"filtering"},{"content":"Ordering","slug":"ordering"},{"content":"GET","slug":"get"},{"content":"Create & Update","slug":"create-update"},{"content":"Status Codes","slug":"status-codes"}],"owner":"23562257","collectionId":"a4b45158-d55d-41fc-bb40-f8e070e3783f","publishedId":"2s93JnTRg1","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"1f1d23","highlight":"f46b44"},"publishDate":"2025-07-07T21:00:43.000Z"},"item":[{"name":"API v2","item":[{"name":"Additional Fields","item":[{"name":"Get Additional Fields","event":[{"listen":"test","script":{"id":"ea6ff400-b1ee-4f42-af65-e8296b84b07c","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"d2dec924-98a7-44aa-bce7-1f19d3e7b480","exec":["const testvar = pm.variables.get(\"test-var\");","","console.log(testvar)"],"type":"text/javascript","packages":{}}}],"id":"3ddb667d-059b-47ab-8901-66a6b4a63518","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.spark.re/v2/additional-fields?standardized_field_id_eq=1&value_cont=yes","auth":{"type":"apikey","apikey":{"value":"[integer] Which page of results to return
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"[integer] The number of results returned per page. Defaults to 25
\n","type":"text/plain"},"key":"per_page","value":"25"},{"disabled":true,"description":{"content":"[string] Provide a field name to change the sort order. Defaults to created_at
\n","type":"text/plain"},"key":"order","value":"created_at"},{"disabled":true,"description":{"content":"[string] Accepts asc or desc. Defaults to desc
\n","type":"text/plain"},"key":"direction","value":"desc"},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"created_at_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"name_#","value":""},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"updated_at_#","value":""},{"key":"standardized_field_id_eq","value":"1"},{"key":"value_cont","value":"yes"}],"variable":[]}},"response":[],"_postman_id":"3ddb667d-059b-47ab-8901-66a6b4a63518"},{"name":"Get Additional Field","id":"136c5dde-d989-4670-a496-fad72e0586a3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.spark.re/v2/additional-fields/:id","auth":{"type":"apikey","apikey":{"value":"Required. Enter a single ID
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"136c5dde-d989-4670-a496-fad72e0586a3"}],"id":"c2e74f28-9cf1-48a9-be0f-e4a66c89200c","description":"An additional field is a non Spark default, custom field that can be used with contacts, contracts, inventory, reservations, and team members.
\nAn additional field on a object (like contacts) can either be associated with a standardized field, or can be a one off value.
\n","event":[{"listen":"prerequest","script":{"id":"8bd40226-a4c2-4d67-bba9-eb619fbe61f5","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f5dda8d4-a5b9-42ad-977a-f8a7e1ea81d3","type":"text/javascript","exec":[""]}}],"_postman_id":"c2e74f28-9cf1-48a9-be0f-e4a66c89200c","auth":{"type":"apikey","apikey":{"value":"[integer] Which page of results to return
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"[integer] The number of results returned per page. Defaults to 25
\n","type":"text/plain"},"key":"per_page","value":"25"},{"disabled":true,"description":{"content":"[string] Provide a field name to change the sort order. Defaults to created_at
\n","type":"text/plain"},"key":"order","value":"created_at"},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"created_at_#","value":""},{"disabled":true,"description":{"content":"[string] Accepts asc or desc. Defaults to desc
\n","type":"text/plain"},"key":"direction","value":"desc"},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"input_type_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"name_#","value":""},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"updated_at_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"value_format_#","value":""}],"variable":[]}},"response":[],"_postman_id":"e33d68d6-dad1-478d-805a-67f4bad1fc9a"},{"name":"Get Custom Field","id":"7c33b813-54bf-43a3-a74e-f203175ff7fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.spark.re/v2/custom-fields/:id","auth":{"type":"apikey","apikey":{"value":"Required. Enter a single ID
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"7c33b813-54bf-43a3-a74e-f203175ff7fe"},{"name":"Create Custom Field","id":"715a9821-8ec2-418f-836a-a03104274363","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n // Required. Name of the Custom Field.\n \"name\": \"Colorado\",\n\n // The description of the Custom Field. Used to provide further context \n // to field and it's values.\n \"description\": \"Focused actuating archive\",\n\n // Not currently in use. May be used to determine order of Custom Field.\n \"position\": \"569\",\n\n // Required. The category determines whom this Custom Field will be accessible to:\n // [\n // \"brokerage\", \"company_contact\", \"company_user\", \"contract\", \n // \"inventory\", \"project_contact\", \"project_user\"\n // ]\n // Note: \"brokerage\", \"company_contact\" and \"company_user\" can only be created with\n // a company level API key.\n \"category\": \"inventory\",\n\n // Required. The input_type determines how the Custom Field will appear in the UI.\n // Acceptable types are: \n // [\n // \"checkbox\", \"currency\", \"date\", \"date_time\", \"dropdown\", \"long_text\",\n // \"measurement\", \"number\", \"percentage\", \"radio\", \"short_text\"\n // ] \n \"input_type\": \"dropdown\",\n\n // The selectable values of a Custom Field. Use to provide a list of options for \n // checkbox, dropdown or radio input types\n \"options\": [\"Down-sized\", \"global\", \"pink\"],\n\n // Is it possible to add unique/customized options to this custom field? Used \n // for checkbox, dropdown or radio input_types only. \n \"other_options\": false,\n\n // Is it possible to select multiple options in a dropdown? \n \"multiple_choice\": false,\n\n // Is it required to complete this Custom Field when submitting a form?\n \"required\": false,\n\n // The format that a measurement input_type should use. \n // {\n // \"imperial length\" => [\"in\", \"ft\", \"yd\", \"mi\"],\n // \"imperial area\" => [\"in²\", \"ft²\", \"yd²\"],\n // \"metric length\" => [\"mm\", \"cm\", \"m\", \"km\"],\n // \"metric area\" => [\"mm²\", \"cm²\", \"m²\"]\n // }\n \"value_format\": \"ft\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.spark.re/v2/custom-fields","description":"A POST request to create a new custom field. The custom field's name, category and input_type are required to create a new custom field.
\nSee the POST /v2/custom-fields (Create Custom Field) Body for a list of available fields, and the expected format for submitting values.
A custom field is a non Spark default attribute that can be used with contacts, contracts, brokerage, inventory, reservations, and team members.
\nA custom field on an object (like contacts) is associated to the owner record and stores it's value on the record as a custom_field_value
\nWhen using a Company API Key:
\nCreates a Custom Field at the company level.
\nIf the field is for Contacts, Brokerages, or Team Members, it is automatically shared across all projects.
\nIf the field is for Inventory or Contracts, it is not shared by default and must be explicitly shared with projects through the UI.
\nWhen using a Project API Key:
\nCreates a Custom Field only at the project level.
\nThese fields remain exclusive to the project and cannot be shared across projects.
\n[integer] Which page of results to return
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"[integer] The number of results returned per page. Defaults to 25
\n","type":"text/plain"},"key":"per_page","value":"25"},{"disabled":true,"description":{"content":"[string] Provide a field name to change the sort order. Defaults to created_at
\n","type":"text/plain"},"key":"order","value":"created_at"},{"disabled":true,"description":{"content":"[string] Accepts asc or desc. Defaults to desc
\n","type":"text/plain"},"key":"direction","value":"desc"},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"city_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"country_iso_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"country_name_#","value":""},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"created_at_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"name_#","value":""},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"updated_at_#","value":""}],"variable":[]}},"response":[],"_postman_id":"5b644b85-42f8-40fd-83e1-614a975a0ae1"},{"name":"Get Brokerage","id":"a66b6ba1-a63f-4617-bc55-2ea274a623b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.spark.re/v2/brokerages/:id","auth":{"type":"apikey","apikey":{"value":"Required. Enter a single ID
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"a66b6ba1-a63f-4617-bc55-2ea274a623b8"},{"name":"Create Brokerage","event":[{"listen":"prerequest","script":{"id":"21bf38e1-b73b-4ac9-bbb6-bd2fb169783a","exec":[""],"type":"text/javascript"}}],"id":"26a28e53-a5cd-4f6e-bc57-7350e38dbb19","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n // Additional fields accept custom values that do not\n // exist in Spark by default. They can either be a one\n // off on a single contact, or predefined as a standardized \n // field that unlocks additional functionality. Spark accepts \n // these using either of the formats below.\n \"additional_fields\": [\n {\n // Will find and assign a standardized field id if the name field\n // matches. Will create a one off additional field otherwise\n \"name\": \"HTTP\",\n\n // A value for this additional/standardized field\n \"value\": \"mobile\"\n },\n {\n // See \"Standardized Fields\" for IDs\n \"standardized_field_id\": \"\",\n\n // Value for this additional field\n \"value\": \"Account\"\n }\n ],\n\n // Street address where this brokerage is located\n \"address_line_1\": \"2861 Medhurst Station\",\n\n // Additional street address where this brokerage is located\n // Usually suite, unit, or flat number\n \"address_line_2\": \"Unit 101\",\n\n // The city where the brokerage is located\n \"city\": \"Friesenfurt\",\n\n // Country where this brokerage is located\n // Mutually exclusive with country_name\n \"country_iso\": \"{{iso-of-random-countries-result}}\",\n \n // Country where this brokerage is located\n // Mutually exclusive with country_iso\n \"country_name\": \"Canada\",\n\n // Custom Fields accept a varity of values that is determined by the\n // input_type. The following are the value formats accepted by the \n // Custom Field of a given input_type:\n // {\n // checkbox: array,\n // currency: float,\n // date: date,\n // date_time: datetime,\n // dropdown: array,\n // long_text: string,\n // measurement: float,\n // number: float,\n // percentage: float,\n // radio: string,\n // short_text: string\n // }\n \"custom_field_values\": [\n {\n // See \"Custom Fields for IDs\"\n \"custom_field_id\": \"{{id-of-first-custom-fields-result\",\n\n // The value for this Custom Field\n \"value\": \"Profit-focused\"\n }\n ],\n\n // Email address for the brokerage\n // Usually for general inquires or support\n \"email\": \"Carrie47@example.net\",\n\n // Fax number for the brokerage\n \"fax\": \"516-785-0309\",\n\n // Licence number of the brokerage\n \"licence\": \"966\",\n\n // Managing broker (agent) of the brokerage\n // See \"Contacts\" for IDs\n \"manager_id\": \"\",\n\n // Name of the brokerage\n \"name\": \"Zieme, Goodwin and Emard\",\n\n // Phone number of the brokerage\n // Email or phone are required\n \"phone\": \"637-624-6474\",\n\n // Postal/zip code of where the brokerage is located\n \"postcode\": \"13\",\n\n // Province/state where the brokerage is located\n \"province\": \"National\",\n\n // Website for the brokerage\n // Should include http:// or https://\n \"website\": \"https://www.example.com\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://api.spark.re/v2/brokerages","description":"A POST request to create a new brokerage. Only a name is required to create a new brokerage although we recommended you include as much information as you have available.
\nSee the POST /v2/brokerages (Create Brokerage) Body for a list of available fields, and the expected format for submitting values.
A brokerage is a company that a real estate agent works for, and is the recipient of external commissions on a contract or reservation.
\n","event":[{"listen":"prerequest","script":{"id":"8bd40226-a4c2-4d67-bba9-eb619fbe61f5","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f5dda8d4-a5b9-42ad-977a-f8a7e1ea81d3","type":"text/javascript","exec":[""]}}],"_postman_id":"8c574f5c-d757-4f16-823a-544380003d9e","auth":{"type":"apikey","apikey":{"value":"A company is the real estate developer, marketing firm, or brokerage who is using our platform.
\n","_postman_id":"6ba542af-d11b-4733-9f8e-b65db01aaa32","auth":{"type":"apikey","apikey":{"value":"[integer] Which page of results to return
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"[integer] The number of results returned per page. Defaults to 25
\n","type":"text/plain"},"key":"per_page","value":"25"},{"disabled":true,"description":{"content":"[string] Provide a field name to change the sort order. Defaults to created_at
\n","type":"text/plain"},"key":"order","value":"created_at"},{"disabled":true,"description":{"content":"[string] Accepts asc or desc. Defaults to desc
\n","type":"text/plain"},"key":"direction","value":"desc"},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"created_at_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"name_#","value":""},{"disabled":true,"description":{"content":"[integer]
\n","type":"text/plain"},"key":"team_member_id_#","value":""},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"updated_at_#","value":""}],"variable":[]}},"response":[],"_postman_id":"eac99411-c59f-4ef6-b728-79a8b1d0ac5b"},{"name":"Get Contact Group","id":"b630d4e8-10b6-4142-9186-7b112a6edcc2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.spark.re/v2/contact-groups/:id","description":"A GET request to find a contact by email.
\n","auth":{"type":"apikey","apikey":{"value":"Required. Enter a single ID
\n","type":"text/plain"},"type":"string","value":"","key":"id"}]}},"response":[],"_postman_id":"b630d4e8-10b6-4142-9186-7b112a6edcc2"}],"id":"9206bbaf-1064-4f90-a9de-c6750437d513","description":"A contact group is a group of contacts.
\n","_postman_id":"9206bbaf-1064-4f90-a9de-c6750437d513","auth":{"type":"apikey","apikey":{"value":"[integer] Which page of results to return
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"[integer] The number of results returned per page. Defaults to 25
\n","type":"text/plain"},"key":"per_page","value":"25"},{"disabled":true,"description":{"content":"[string] Provide a field name to change the sort order. Defaults to created_at
\n","type":"text/plain"},"key":"order","value":"created_at"},{"disabled":true,"description":{"content":"[string] Accepts asc or desc. Defaults to desc
\n","type":"text/plain"},"key":"direction","value":"desc"},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"created_at_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"value_#","value":"Hot"},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"updated_at_#","value":""}],"variable":[]}},"response":[],"_postman_id":"e0f5cae0-b224-45c9-825b-3d2255de3d69"},{"name":"Get Contact Rating","id":"295cc8f6-3ac5-425b-a088-ee5c5fdc4cf0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.spark.re/v2/contact-ratings/:id","description":"A GET request to find a contact rating by id.
\n","auth":{"type":"apikey","apikey":{"value":"Required. Enter a single ID
\n","type":"text/plain"},"type":"string","value":"","key":"id"}]}},"response":[],"_postman_id":"295cc8f6-3ac5-425b-a088-ee5c5fdc4cf0"}],"id":"cc49786a-5662-45c3-be63-cde043dbd3c0","description":"A contact rating is assigned to a contact to classify their potential to purchase a unit.
\n","_postman_id":"cc49786a-5662-45c3-be63-cde043dbd3c0","auth":{"type":"apikey","apikey":{"value":"[integer] Which page of results to return
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"[integer] The number of results returned per page. Defaults to 25
\n","type":"text/plain"},"key":"per_page","value":"25"},{"disabled":true,"description":{"content":"[string] Provide a field name to change the sort order. Defaults to created_at
\n","type":"text/plain"},"key":"order","value":"created_at"},{"disabled":true,"description":{"content":"[string] Accepts asc or desc. Defaults to desc
\n","type":"text/plain"},"key":"direction","value":"desc"},{"disabled":true,"description":{"content":"[boolean]
\n","type":"text/plain"},"key":"agent_#","value":""},{"disabled":true,"description":{"content":"[integer]
\n","type":"text/plain"},"key":"brokerage_id_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"city_#","value":""},{"disabled":true,"description":{"content":"[integer]
\n","type":"text/plain"},"key":"contact_group_id_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"country_iso_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"country_name_#","value":""},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"created_at_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"email_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"first_name_#","value":""},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"last_interaction_date_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"last_name_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"marketing_source_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"postcode_#","value":""},{"disabled":true,"description":{"content":"[integer]
\n","type":"text/plain"},"key":"project_id_#","value":""},{"disabled":true,"description":{"content":"[integer]
\n","type":"text/plain"},"key":"rating_id_#","value":""},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"registered_at_#","value":""},{"disabled":true,"description":{"content":"[integer]
\n","type":"text/plain"},"key":"team_member_id_#","value":""},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"updated_at_#","value":""}],"variable":[]}},"response":[],"_postman_id":"4c3aa358-cc7b-40f6-8cb3-bf5c1c35b1a3"},{"name":"Get Contact","id":"71b3c40f-ca3c-46e0-a179-9ddfde751aa8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.spark.re/v2/contacts/:id","auth":{"type":"apikey","apikey":{"value":"Required. Enter a single ID
\n","type":"text/plain"},"type":"string","value":"","key":"id"}]}},"response":[],"_postman_id":"71b3c40f-ca3c-46e0-a179-9ddfde751aa8"},{"name":"Create Contact","event":[{"listen":"prerequest","script":{"id":"21bf38e1-b73b-4ac9-bbb6-bd2fb169783a","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"87690d76-6bfc-4f41-8881-0fefd8539729","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n // Additional fields accept custom values that do not\n // exist in Spark by default. They can be predefined as a standardized \n // field that unlocks additional functionality. Spark accepts \n // these using either of the formats below.\n // \"additional_fields\": [\n // {\n // // Will find and assign a standardized field id if the name field\n // // matches.\n // \"name\": \"payment\",\n\n // // A value for this additional/standardized field\n // \"value\": \"relationships\"\n // },\n // {\n // // See \"Standardized Fields\" for IDs\n // \"standardized_field_id\": \"\",\n\n // // Value for this additional field\n // \"value\": \"override\"\n // }\n // ],\n\n // // Street address where this contact is located\n // \"address_line_1\": \"5082 Katarina Ridge\",\n\n // // Additional street address where this contact is located\n // // Usually suite, unit, or flat number\n // \"address_line_2\": \"Unit 101\",\n\n // // Contacts who are clients of this agent (broker)\n // // See \"Contacts\" for IDs\n // \"agent_client_ids\": [],\n\n // // Contacts to assign as an agent (broker) for this contact\n // // See \"Contacts\" for IDs\n // \"agent_ids\": [],\n\n // // Is this contact a real estate agent (broker)?\n // \"agent\": true,\n\n // // Brokerage the agent (broker) works for\n // // See \"Brokerages\" for IDs\n // \"brokerage_id\": ,\n\n // // City where the contact is located\n // \"city\": \"Ivahborough\",\n\n // // A list of contact groups to add this contact to\n // // This does not accept groups with smart filters\n // // See \"Contact Groups\" for IDs\n // \"contact_group_ids\": [\n // \n // ],\n\n // // How this contact prefers to be contacted\n // \"contact_preference\": \"Email\",\n\n // // Country where this contact is located\n // // Mutually exclusive with country_name\n // \"country_iso\": \"{{iso-of-random-countries-result}}\",\n \n // // Country where this contact is located\n // // Mutually exclusive with country_iso\n // \"country_name\": \"Canada\",\n\n // // Custom Fields accept a varity of values that is determined by the\n // // input_type. The following are the value formats accepted by the \n // // Custom Field of a given input_type:\n // // {\n // // checkbox: array,\n // // currency: float,\n // // date: date,\n // // date_time: datetime,\n // // dropdown: array,\n // // long_text: string,\n // // measurement: float,\n // // number: float,\n // // percentage: float,\n // // radio: string,\n // // short_text: string\n // // }\n \"custom_field_values\": [\n {\n // See \"Custom Fields for IDs\"\n \"custom_field_id\": \"{{id-of-first-custom-fields-result\",\n\n // The value for this Custom Field\n \"value\": \"Virginia\"\n }\n ],\n \n // Date of birth of the contact\n \"date_of_birth\": \"2026-06-14T09:39:32.210Z\",\n\n // // Email or phone are required\n // // If a contact is submitted with an email address that \n // // already exists in the database, it will update the \n // // existing contact with the submitted details.\n \"email\": \"Marjory64@example.org\",\n\n // Employer at which the contact works\n // Should be null if being assigned to a brokerage or legal firm\n // \"employer\": \"Feil, Robel and Rodriguez\",\n\n // // Fax number for the contact\n // \"fax\": \"784-510-4724\",\n\n // First name of the contact\n \"first_name\": \"Adrienne\",\n\n // Floorplans this contact is interested in\n // See \"Floorplans\" for IDs\n \"floorplans_interested_ids\": [\n 2, 3\n ],\n\n // Followup schedule to assign to this contact\n // Note: If creating a new contact or updating a contact without team\n // members assigned, a team_member_ids param is required in the request\n // See \"Followup Schedules\" for IDs\n // \"followup_schedule_id\": ,\n\n // // Type of document used to verify this contact\n // \"id_doc_type\": \"Drivers Licence\",\n\n // Inventory this contact is interested in\n // See \"Inventory\" for IDs\n \"inventory_interested_ids\": [\n 42, 22, 48\n ],\n\n // What this contact does for a living\n // \"job_title\": \"Corporate Group Orchestrator\",\n\n // Last name of the contact\n \"last_name\": \"Hodkiewicz\",\n\n // Is this contact a legal (lawyer)?\n // \"legal\": true,\n\n // Contacts to assign as clients of this legal (lawyer)\n // See \"Contacts\" for IDs\n \"legal_client_ids\": [],\n\n // Contacts to assign as a legal (lawyer) for this contact\n // See \"Contacts\" for IDs\n \"legal_ids\": [],\n\n // Legal firm the legal (lawyer) works for\n // See \"Legal Firms\" for IDs\n \"legal_firm_id\": ,\n\n // The legal (full) name of this contact as it would \n // appear on thier birth certificate or drivers license\n \"legal_name\": \"Opal Rippin\",\n\n // A source provided by the contact to track where\n // they heard about the project. This is usually set\n // by the marketing source question, but can be set \n // manually if needed\n \"marketing_source\": \"Billboard\",\n\n // Mobile/secondary phone number of the contact\n \"mobile_phone\": \"767-602-2543\",\n\n // Nationality of the contact\n \"nationality\": \"Canadian\",\n\n // A datetime when the contact opted in to receive communications from the company/project\n \"opted_in_at\": null,\n\n // A datetime when the contact opted out of receiving communications from the company/project\n // Usually by unsubscribing from a email campaign\n \"opted_out_at\": null,\n\n // Primary phone number of the contact\n // Email or phone are required\n \"phone\": \"613-245-9630\",\n\n // Postal/zip code of where the contact lives\n \"postcode\": \"895\",\n\n // Province where the contact lives\n \"province\": \"black\",\n\n // // Question answers are used for tracking a contacts\n // // answers to predefined questions. Spark accepts these\n // // using either of the formats below.\n \"question_answers\": [\n {\n // Will find and assign a question id if the \n // question field matches\n \"question\": \"Borders Alaska digital mint state\",\n\n // Answers for this question\n \"answers\": [\n \"Granite\",\n \"copying\"\n ]\n },\n {\n // See \"Questions\" for IDs\n \"question_id\": \"\",\n\n // Answers for this question\n \"answers\": [\"Handcrafted\"]\n }\n ],\n\n // A rating to classify their likelihood of purchasing\n // See \"Contact Ratings\" for IDs\n \"rating_id\": ,\n\n // A datetime when the contact registered for the project\n // \"registered_at\": null,\n\n // Registration source to assign to this contact\n // See \"Registration Sources\" for IDs\n \"registration_source_id\": ,\n\n // Team members to assign to this contact\n // See \"Team Members\" for IDs\n \"team_member_ids\": [\n 66, 3\n ],\n\n // Can be used as an additional classification\n // Usually used for agents, but available for all contacts\n // \"tier\": null,\n\n // Mr. Mrs. Ms. Dr. etc.\n \"title\": null,\n\n // X (Twitter) handle of the contact\n \"twitter_handle\": null,\n\n // Website for the contact\n // Should include http:// or https://\n \"website\": \"https://www.example.com\",\n\n // Work phone number of the contact\n \"work_phone\": \"270-855-6938\",\n\n // Tracking cookie ID generated by Spark tracking script\n \"tracking_cookie_id\": \"{{tracking_cookie_id}}\",\n\n // URL of the page where the user submitted the client form\n \"tracking_page_url\": \"https://www.example.com\",\n\n // Referrer of the page where the form was submitted\n \"tracking_referrer\": \"https://www.example.com/referrer\",\n\n // UTM fields captured from the initial visit and passed through backend\n \"tracking_utm_source\": \"example_source\",\n \"tracking_utm_medium\": \"medium-test\",\n \"tracking_utm_campaign\": \"utm_campaign_name\",\n \"tracking_utm_term\": \"Rustic\",\n \"tracking_utm_content\": \"Wyoming multi-tasking black pink navigate\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://api.spark.re/v2/contacts","description":"Note: The create endpoint does not work with a company API key.
\nA POST request to create a new contact. Only an email or phone is required to create a new contact although we recommended you include as much information as you have available.
\nIf a contact is submitted with an email address that already exists in the database, it will update the existing contact with the submitted details.
\nSee the POST /v2/contacts (Create Contact) Body for a list of available fields, and the expected format for submitting values.
Note: The update endpoint does not work with a company API key.
\nA PUT request to update a specific contact by ID.
\nSee the POST /v2/contacts (Create Contact) Body for a list of available fields, and the expected format for submitting values.
Required. Enter a single ID
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"e371d6e7-256b-4eae-981a-898f13c789d0"}],"id":"d2fab828-0f0f-420d-bff7-33ee83fd98c4","description":"A contact is a registrant, lead, or person that is interested in, or has purchased a unit with the project or company. These contacts can self register, be imported, or transfered from another project.
\n","_postman_id":"d2fab828-0f0f-420d-bff7-33ee83fd98c4","auth":{"type":"apikey","apikey":{"value":"[integer] Which page of results to return
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"[integer] The number of results returned per page. Defaults to 25
\n","type":"text/plain"},"key":"per_page","value":"25"},{"disabled":true,"description":{"content":"[string] Provide a field name to change the sort order. Defaults to created_at
\n","type":"text/plain"},"key":"order","value":"created_at"},{"disabled":true,"description":{"content":"[string] Accepts asc or desc. Defaults to desc
\n","type":"text/plain"},"key":"direction","value":"desc"},{"disabled":true,"description":{"content":"[integer]
\n","type":"text/plain"},"key":"agent_id_#","value":""},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"created_at_#","value":""},{"disabled":true,"description":{"content":"[integer]
\n","type":"text/plain"},"key":"inventory_id_#","value":""},{"disabled":true,"description":{"content":"[integer]
\n","type":"text/plain"},"key":"primary_purchaser_id_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"primary_purchaser_email_#","value":""},{"disabled":true,"description":{"content":"[integer]
\n","type":"text/plain"},"key":"secondary_purchaser_id_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"secondary_purchaser_email_#","value":""},{"disabled":true,"description":{"content":"[intger]
\n","type":"text/plain"},"key":"status_id_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"status_value_#","value":""},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"updated_at_#","value":""}],"variable":[]}},"response":[],"_postman_id":"e5c3197e-ce88-4a08-877b-78c052d0d338"},{"name":"Get Contract","id":"4af8b871-840b-4ff4-9761-1624b22f097e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.spark.re/v2/contracts/:id","auth":{"type":"apikey","apikey":{"value":"Required. Enter a single ID
\n","type":"text/plain"},"type":"string","value":"","key":"id"}]}},"response":[{"id":"1c0b7c7b-da4a-4333-b1bf-a8ef7e5685a1","name":"Get Contract","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.spark.re/v2/contracts/:id","host":["https://api.spark.re"],"path":["v2","contracts",":id"],"variable":[{"key":"id","value":"","type":"string","description":"Required. Enter a single ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Date","value":"Tue, 14 Mar 2023 18:58:31 GMT","enabled":true},{"key":"X-Frame-Options","value":"SAMEORIGIN","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Download-Options","value":"noopen","enabled":true},{"key":"X-Permitted-Cross-Domain-Policies","value":"none","enabled":true},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin","enabled":true},{"key":"Cache-Control","value":"no-store","enabled":true},{"key":"ETag","value":"W/\"592f2bb0981b95a7b23ae0e0b9745103\"","enabled":true},{"key":"X-Request-Id","value":"ff3112c7-4474-472f-925b-117f78d90e3a","enabled":true},{"key":"X-Runtime","value":"0.170431","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=1800","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"X-Robots-Tag","value":"noindex, nofollow, nosnippet, noarchive","enabled":true},{"key":"X-Cache","value":"Miss from cloudfront","enabled":true},{"key":"Via","value":"1.1 49cdeca097624936e070b73619df7da8.cloudfront.net (CloudFront)","enabled":true},{"key":"X-Amz-Cf-Pop","value":"SEA19-C1","enabled":true},{"key":"X-Amz-Cf-Id","value":"-cqXxStBxHXspZmIY74A1gkwGGq6C7VNKY_XVmetjsOQ0uwYPWqZsw==","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 478,\n \"accepted_date\": null,\n \"addendum\": \"\",\n \"additional_purchasers\": [],\n \"adjusted_price\": 142679200,\n \"adjusted_price_per_area\": 52900,\n \"agents\": [],\n \"assignees\": [],\n \"brokerages\": [],\n \"color_schemes\": [],\n \"color_schemes_discount_total\": 0,\n \"color_schemes_subtotal\": 0,\n \"color_schemes_tax_total\": 0,\n \"color_schemes_total\": 0,\n \"completion_date\": null,\n \"contract_list_price\": 0,\n \"counter_signers\": [],\n \"created_at\": \"2023-03-01T21:44:33Z\",\n \"date\": null,\n \"deposits\": [\n {\n \"id\": 698,\n \"applied_to\": \"Unit 668 - 457\",\n \"contract_id\": 478,\n \"created_at\": \"2023-03-01T21:44:34Z\",\n \"description\": \"A fixed amount that is paid towards the succeeding percentage deposit.\",\n \"due_date\": null,\n \"fixed\": false,\n \"less_fixed\": true,\n \"less_percent\": false,\n \"name\": \"Initial Deposit\",\n \"origin\": \"Resident (Unit)\",\n \"owed_amount\": 29535840,\n \"paid_amount\": 0,\n \"percentage_owed\": 100,\n \"percentage_paid\": 0,\n \"project_id\": 1,\n \"standalone\": false,\n \"status\": \"Pending\",\n \"subtotal_amount\": 29535840,\n \"total_amount\": 29535840,\n \"type\": \"Unit\",\n \"updated_at\": \"2023-03-01T21:44:34Z\"\n },\n {\n \"id\": 699,\n \"applied_to\": \"Unit 668 - 457\",\n \"contract_id\": 478,\n \"created_at\": \"2023-03-01T21:44:34Z\",\n \"description\": \"A percentage amount minus the preceding initial fixed deposit.\",\n \"due_date\": null,\n \"fixed\": false,\n \"less_fixed\": false,\n \"less_percent\": true,\n \"name\": \"1st Deposit Less Initial\",\n \"origin\": \"Resident (Unit)\",\n \"owed_amount\": 0,\n \"paid_amount\": 0,\n \"percentage_owed\": 0,\n \"percentage_paid\": 100,\n \"project_id\": 1,\n \"standalone\": false,\n \"status\": \"Paid\",\n \"subtotal_amount\": 0,\n \"total_amount\": 0,\n \"type\": \"Unit\",\n \"updated_at\": \"2023-03-01T21:44:35Z\"\n },\n {\n \"id\": 700,\n \"applied_to\": \"Unit 668 - 457\",\n \"contract_id\": 478,\n \"created_at\": \"2023-03-01T21:44:35Z\",\n \"description\": null,\n \"due_date\": null,\n \"fixed\": false,\n \"less_fixed\": false,\n \"less_percent\": false,\n \"name\": \"2nd Deposit\",\n \"origin\": \"Resident (Unit)\",\n \"owed_amount\": 29535840,\n \"paid_amount\": 0,\n \"percentage_owed\": 100,\n \"percentage_paid\": 0,\n \"project_id\": 1,\n \"standalone\": false,\n \"status\": \"Pending\",\n \"subtotal_amount\": 29535840,\n \"total_amount\": 29535840,\n \"type\": \"Unit\",\n \"updated_at\": \"2023-03-01T21:44:35Z\"\n }\n ],\n \"deposits_total\": 59071680,\n \"discounts_total\": 0,\n \"estimated_completion_date\": \"2023-03-02\",\n \"external_commissions\": [],\n \"firm_date\": null,\n \"floorplan\": {\n \"id\": 10,\n \"color\": \"c24476\",\n \"created_at\": \"2023-01-17T10:50:26Z\",\n \"file\": {\n \"url\": null\n },\n \"file_name\": null,\n \"image\": null,\n \"name\": \"V5\",\n \"project_id\": 1,\n \"updated_at\": \"2023-03-13T22:43:09Z\"\n },\n \"internal_commissions\": [],\n \"inventory\": {\n \"id\": 3,\n \"accepted_at\": null,\n \"accepted_contract_id\": null,\n \"active_contracts_count\": 0,\n \"area\": 2696,\n \"area_unit\": \"SQFT\",\n \"bathrooms\": \"2\",\n \"bedrooms\": \"4\",\n \"building\": null,\n \"created_at\": \"2023-01-07T05:42:38Z\",\n \"estimated_closing_date\": null,\n \"estimated_completion\": null,\n \"estimated_move_in\": null,\n \"exposures\": [\n \"S\"\n ],\n \"exterior_area\": 120,\n \"exterior_type\": null,\n \"floor\": 6,\n \"floorplan_id\": 10,\n \"kind\": null,\n \"lease\": false,\n \"leasing_term\": null,\n \"line\": null,\n \"offer_at\": null,\n \"origin\": \"Spark\",\n \"parking_stall_count\": 2,\n \"parking_stall_numbers\": [\n \"5\",\n \"12\"\n ],\n \"price\": 142679200,\n \"price_per_area\": 52900,\n \"project_id\": 1,\n \"rescissions_count\": 0,\n \"sold_at\": null,\n \"status_id\": 11,\n \"storage_locker_count\": null,\n \"storage_locker_numbers\": [\n \"[0\",\n \"100]\"\n ],\n \"strata_lot\": \"457\",\n \"unit\": \"668\",\n \"updated_at\": \"2023-03-01T21:44:41Z\"\n },\n \"legal_firms\": [],\n \"legals\": [],\n \"lenders\": [],\n \"move_in_date\": \"2023-03-02T19:11:00Z\",\n \"notes\": [],\n \"offer_created_at\": null,\n \"parking_stalls\": [\n {\n \"id\": 5,\n \"archived_at\": null,\n \"building\": null,\n \"contract_id\": 478,\n \"created_at\": \"2023-03-01T21:44:38Z\",\n \"discount\": 0,\n \"included\": true,\n \"name\": \"5\",\n \"number\": \"5\",\n \"prefix\": \"\",\n \"price\": 0,\n \"subtotal\": 0,\n \"suffix\": \"\",\n \"tax\": 0,\n \"total\": 0,\n \"type\": {\n \"id\": 1,\n \"archived_at\": null,\n \"contract_id\": 478,\n \"cost\": 0,\n \"created_at\": \"2023-03-01T21:44:38Z\",\n \"discount\": 0,\n \"editable_on_contract\": true,\n \"name\": \"Standard\",\n \"parking_stall_id\": 5,\n \"price\": 0,\n \"subtotal\": 0,\n \"tax\": 0,\n \"total\": 0,\n \"updated_at\": \"2023-03-01T21:44:38Z\"\n },\n \"updated_at\": \"2023-03-01T21:44:38Z\",\n \"upgrades\": []\n },\n {\n \"id\": 12,\n \"archived_at\": null,\n \"building\": null,\n \"contract_id\": 478,\n \"created_at\": \"2023-03-01T21:44:39Z\",\n \"discount\": 0,\n \"included\": true,\n \"name\": \"12\",\n \"number\": \"12\",\n \"prefix\": \"\",\n \"price\": 700000,\n \"subtotal\": 700000,\n \"suffix\": \"\",\n \"tax\": 0,\n \"total\": 700000,\n \"type\": {\n \"id\": 1,\n \"archived_at\": null,\n \"contract_id\": 478,\n \"cost\": 0,\n \"created_at\": \"2023-03-01T21:44:39Z\",\n \"discount\": 0,\n \"editable_on_contract\": true,\n \"name\": \"Standard\",\n \"parking_stall_id\": 12,\n \"price\": 500000,\n \"subtotal\": 500000,\n \"tax\": 0,\n \"total\": 500000,\n \"updated_at\": \"2023-03-01T21:44:39Z\"\n },\n \"updated_at\": \"2023-03-01T21:44:39Z\",\n \"upgrades\": [\n {\n \"id\": 3,\n \"active\": false,\n \"archived_at\": null,\n \"contract_id\": 478,\n \"cost\": 50000,\n \"created_at\": \"2023-03-01T21:44:39Z\",\n \"discount\": 0,\n \"fixed\": false,\n \"name\": \"Elevator Proximity\",\n \"parking_stall_id\": 12,\n \"price\": 200000,\n \"removable_on_contract\": false,\n \"subtotal\": 200000,\n \"tax\": 0,\n \"total\": 200000,\n \"updated_at\": \"2023-03-01T21:44:40Z\"\n }\n ]\n }\n ],\n \"possession_date\": \"2023-03-02T19:11:00Z\",\n \"primary_purchaser\": {\n \"id\": 394,\n \"active\": true,\n \"additional_fields\": {},\n \"contact_attributes\": {},\n \"contact_id\": null,\n \"contract_id\": 478,\n \"created_at\": \"2023-03-01T21:49:44Z\",\n \"hierarchy\": \"primary\",\n \"position\": null,\n \"updated_at\": \"2023-03-01T21:49:44Z\"\n },\n \"project_id\": 1,\n \"purchase_price\": 142679200,\n \"purchase_price_per_area\": 52900,\n \"reservation\": {\n \"id\": 10,\n \"contract_id\": 478,\n \"converted_at\": null,\n \"created_at\": \"2023-03-01T21:44:33Z\",\n \"executed_at\": null,\n \"inventory_id\": 3,\n \"project_id\": 1,\n \"reservation_list_price\": 142679200,\n \"reservation_list_price_per_area\": 52900,\n \"reserved_at\": \"2023-03-01T21:44:33Z\",\n \"status_id\": 1,\n \"updated_at\": \"2023-03-02T19:12:19Z\"\n },\n \"reservation_date\": \"2023-03-01T21:44:33Z\",\n \"secondary_purchaser\": {\n \"id\": 397,\n \"active\": true,\n \"additional_fields\": {},\n \"contact_attributes\": {},\n \"contact_id\": null,\n \"contract_id\": 478,\n \"created_at\": \"2023-03-02T19:12:19Z\",\n \"hierarchy\": \"secondary\",\n \"position\": null,\n \"updated_at\": \"2023-03-02T19:12:19Z\"\n },\n \"sent_for_signatures_at\": null,\n \"status\": {\n \"id\": 1,\n \"color\": \"#CAD2C5\",\n \"created_at\": \"2023-01-20T16:55:15Z\",\n \"project_id\": 1,\n \"updated_at\": \"2023-01-20T16:55:15Z\",\n \"value\": \"Prepping\"\n },\n \"team_members\": [\n {\n \"id\": 1,\n \"country_iso\": null,\n \"country_name\": null,\n \"created_at\": \"2023-01-20T16:55:14Z\",\n \"email\": \"developer@spark.re\",\n \"first_name\": \"Developer\",\n \"job_title\": null,\n \"last_name\": \"Account\",\n \"phone\": \"\",\n \"time_zone\": \"Pacific Time (US & Canada)\",\n \"updated_at\": \"2023-03-14T17:10:47Z\"\n }\n ],\n \"total_price\": 0,\n \"total_taxes\": 54791304,\n \"unit_discount_total\": 0,\n \"unit_tax_total\": 54791304,\n \"updated_at\": \"2023-03-02T19:12:19Z\",\n \"upgrades\": [],\n \"vendor_acceptance_deadline\": null,\n \"writer\": null\n}"}],"_postman_id":"4af8b871-840b-4ff4-9761-1624b22f097e"}],"id":"d8a5d952-48aa-4543-9b82-d5ef30d58d82","description":"A contract is a legally binding document that outlines terms, conditions, exchanges and payment between two parties in a real estate transaction.
\n","_postman_id":"d8a5d952-48aa-4543-9b82-d5ef30d58d82","auth":{"type":"apikey","apikey":{"value":"[integer] Which page of results to return
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"[integer] The number of results returned per page. Defaults to 25
\n","type":"text/plain"},"key":"per_page","value":"25"},{"disabled":true,"description":{"content":"[string] Provide a field name to change the sort order. Defaults to created_at
\n","type":"text/plain"},"key":"order","value":"created_at"},{"disabled":true,"description":{"content":"[string] Accepts asc or desc. Defaults to desc
\n","type":"text/plain"},"key":"direction","value":"desc"},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"created_at_#","value":""},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"updated_at_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"value_#","value":"Available"}],"variable":[]}},"response":[],"_postman_id":"2cd8621a-98bf-4f41-a94c-c87a9a628905"},{"name":"Get Contract Status","id":"25722153-2b0e-4b25-abfd-f7c95344001d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.spark.re/v2/contract-statuses/:id","description":"A GET request to find a contract status by ID.
\n","auth":{"type":"apikey","apikey":{"value":"Required. Enter a single ID
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"25722153-2b0e-4b25-abfd-f7c95344001d"}],"id":"826119b6-1dff-4b54-b316-2df46142beff","description":"A contract status represents the current status of a contract
\n","_postman_id":"826119b6-1dff-4b54-b316-2df46142beff","auth":{"type":"apikey","apikey":{"value":"[integer] Which page of results to return
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"[integer] The number of results returned per page. Defaults to 25
\n","type":"text/plain"},"key":"per_page","value":"25"},{"disabled":true,"description":{"content":"[string] Provide a field name to change the sort order. Defaults to created_at
\n","type":"text/plain"},"key":"order","value":"created_at"},{"disabled":true,"description":{"content":"[string] Accepts asc or desc. Defaults to desc
\n","type":"text/plain"},"key":"direction","value":"desc"},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"name","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"iso","value":""}],"variable":[]}},"response":[],"_postman_id":"7174a6b5-4aa4-497d-8998-9c6308da4ca1"}],"id":"c04939be-a040-4d11-beb3-05eddfcb7287","event":[{"listen":"prerequest","script":{"id":"ac56a063-db6a-42ea-8330-9a75aae2493d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"1c6a02a9-6fd7-49e8-9967-eae6ef6e9b38","type":"text/javascript","exec":["var skipIDTest = true;"]}}],"_postman_id":"c04939be-a040-4d11-beb3-05eddfcb7287","description":"","auth":{"type":"apikey","apikey":{"value":"[integer] Which page of results to return
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"[integer] The number of results returned per page. Defaults to 25
\n","type":"text/plain"},"key":"per_page","value":"25"},{"disabled":true,"description":{"content":"[string] Provide a field name to change the sort order. Defaults to created_at
\n","type":"text/plain"},"key":"order","value":"created_at"},{"disabled":true,"description":{"content":"[string] Accepts asc or desc. Defaults to desc
\n","type":"text/plain"},"key":"direction","value":"desc"},{"disabled":true,"description":{"content":"[integer]
\n","type":"text/plain"},"key":"contract_id_#","value":""},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"due_date_#","value":""},{"disabled":true,"description":{"content":"[integer]
\n","type":"text/plain"},"key":"status_id_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"status_value_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"type_#","value":""}],"variable":[]}},"response":[],"_postman_id":"2a0b268f-9c5d-45c4-9fda-05b468ae6aed"},{"name":"Get Deposit","id":"7b64bfb1-592d-49b5-9013-75f30c6727ea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.spark.re/v2/deposits/:id","auth":{"type":"apikey","apikey":{"value":"Required. Enter a single ID
\n","type":"text/plain"},"type":"string","value":"","key":"id"}]}},"response":[],"_postman_id":"7b64bfb1-592d-49b5-9013-75f30c6727ea"}],"id":"1a65034d-335f-4b8a-9f1c-7444694cc2ca","description":"A deposit is a monitary amount that is provided at the time of contract acceptance as consideration for the sale. All amounts get put toward the final amount owed at closing.
\n","_postman_id":"1a65034d-335f-4b8a-9f1c-7444694cc2ca","auth":{"type":"apikey","apikey":{"value":"[integer] Which page of results to return
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"[integer] The number of results returned per page. Defaults to 25
\n","type":"text/plain"},"key":"per_page","value":"25"},{"disabled":true,"description":{"content":"[string] Provide a field name to change the sort order. Defaults to created_at
\n","type":"text/plain"},"key":"order","value":"created_at"},{"disabled":true,"description":{"content":"[string] Accepts asc or desc. Defaults to desc
\n","type":"text/plain"},"key":"direction","value":"desc"},{"disabled":true,"description":{"content":"[integer]
\n","type":"text/plain"},"key":"contact_id_#","value":""},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"created_at_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"description_#","value":""},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"ends_at_#","value":""},{"disabled":true,"description":{"content":"[integer]
\n","type":"text/plain"},"key":"interaction_type_id_#","value":""},{"disabled":true,"description":{"content":"[integer]
\n","type":"text/plain"},"key":"inventory_id_#","value":""},{"disabled":true,"description":{"content":"[boolean]
\n","type":"text/plain"},"key":"is_complete_#","value":""},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"starts_at_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"title_#","value":""},{"disabled":true,"description":{"content":"[integer]
\n","type":"text/plain"},"key":"team_member_id_#","value":""},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"updated_at_#","value":""}],"variable":[]}},"response":[],"_postman_id":"63aa1061-1b0f-4e86-81cd-040936e99e27"},{"name":"Get Event","id":"87e679fe-94c4-468d-83a9-ee6eba256c44","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.spark.re/v2/events/:id","auth":{"type":"apikey","apikey":{"value":"Required. Enter a single ID
\n","type":"text/plain"},"type":"string","value":"","key":"id"}]}},"response":[],"_postman_id":"87e679fe-94c4-468d-83a9-ee6eba256c44"},{"name":"Create Event","id":"cdbb892b-1c1d-46b5-b8ea-4409d5544a79","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n // Contacts to associate with this event\n // See \"Contacts\" for IDs\n \"contact_ids\": [\n \n ],\n\n // Additional description of the event\n \"description\": \"Persistent value-added service-desk\",\n\n // Datetime the event ends\n \"ends_at\": \"2026-06-14T09:39:32.212Z\",\n \n // Type of event taking place\n // See \"Interaction Types\" for IDs\n \"interaction_type_id\": ,\n\n // Inventory to associate with this event\n // See \"Inventory\" for IDs\n \"inventory_ids\": [\n \n ],\n\n // Number of minutes before the event to sent a reminder email\n // to the team member associated\n \"reminder\": 722,\n\n // If this event should be shared with other team members\n // Requires team_member_ids field if true\n \"shared\": false,\n\n // Datetime the event starts\n \"starts_at\": \"2026-06-14T09:39:32.212Z\",\n\n // Team member who owns the event\n // See \"Team Members\" for IDs\n \"team_member_id\": ,\n\n // Title for the event\n \"title\": \"Up-sized scalable strategy\",\n\n // Team members to share this event with\n // See \"Team Members\" for IDs\n \"team_member_ids\": [\n \n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.spark.re/v2/events","description":"Note: The create endpoint does not work with a company API key.
\nA POST request to create a new event. A title, kind, start, and end date are required to create a new event although we recommended you include as much information as you have available.
\nSee the POST /v2/events (Create Event) Body for a list of available fields, and the expected format for submitting values.
An event in a team members calendar.
\n","_postman_id":"8c74ad76-13fc-4a94-b4ff-db8a1e68cf38","auth":{"type":"apikey","apikey":{"value":"[integer] Which page of results to return
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"[integer] The number of results returned per page. Defaults to 25
\n","type":"text/plain"},"key":"per_page","value":"25"},{"disabled":true,"description":{"content":"[string] Provide a field name to change the sort order. Defaults to created_at
\n","type":"text/plain"},"key":"order","value":"created_at"},{"disabled":true,"description":{"content":"[string] Accepts asc or desc. Defaults to desc
\n","type":"text/plain"},"key":"direction","value":"desc"},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"created_at_#","value":""},{"disabled":true,"description":{"content":"[integer]
\n","type":"text/plain"},"key":"contract_id_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"description_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"name_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"status_#","value":""},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"updated_at_#","value":""}],"variable":[]}},"response":[],"_postman_id":"e4aca314-3dc9-44c0-b836-75d6cb2517d7"},{"name":"Get External Commission","id":"2db231d1-7284-46ea-bfa3-fc2794bf1ff6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.spark.re/v2/external-commissions/:id","auth":{"type":"apikey","apikey":{"value":"Required. Enter a single ID
\n","type":"text/plain"},"type":"string","value":"","key":"id"}]}},"response":[],"_postman_id":"2db231d1-7284-46ea-bfa3-fc2794bf1ff6"}],"id":"21973317-ace8-443e-b6ab-9cfce30a0037","description":"An external commission is a monitary amount paid to an real estate agent after a successful real estate sale.
\n","_postman_id":"21973317-ace8-443e-b6ab-9cfce30a0037","auth":{"type":"apikey","apikey":{"value":"[integer] Which page of results to return
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"[integer] The number of results returned per page. Defaults to 25
\n","type":"text/plain"},"key":"per_page","value":"25"},{"disabled":true,"description":{"content":"[string] Provide a field name to change the sort order. Defaults to created_at
\n","type":"text/plain"},"key":"order","value":"created_at"},{"disabled":true,"description":{"content":"[string] Accepts asc or desc. Defaults to desc
\n","type":"text/plain"},"key":"direction","value":"desc"},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"created_at_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"name_#","value":""},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"updated_at_#","value":""}],"variable":[]}},"response":[],"_postman_id":"7340ec2c-d404-45d4-8c97-aa0e694c1399"},{"name":"Get Floorplan","id":"843fcf78-08b0-4c60-a9e1-df90a214f38f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.spark.re/v2/floorplans/:id","auth":{"type":"apikey","apikey":{"value":"Required. Enter a single ID
\n","type":"text/plain"},"type":"string","value":"","key":"id"}]}},"response":[],"_postman_id":"843fcf78-08b0-4c60-a9e1-df90a214f38f"}],"id":"ee0dc510-7a2b-4008-8c41-6c87d1863daa","description":"A floorplan is a common floor layout associated with multiple units (inventory).
\n","_postman_id":"ee0dc510-7a2b-4008-8c41-6c87d1863daa","auth":{"type":"apikey","apikey":{"value":"[integer] Which page of results to return
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"[integer] The number of results returned per page. Defaults to 25
\n","type":"text/plain"},"key":"per_page","value":"25"},{"disabled":true,"description":{"content":"[string] Provide a field name to change the sort order. Defaults to created_at
\n","type":"text/plain"},"key":"order","value":"created_at"},{"disabled":true,"description":{"content":"[string] Accepts asc or desc. Defaults to desc
\n","type":"text/plain"},"key":"direction","value":"desc"},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"created_at_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"name_#","value":""},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"updated_at_#","value":""}],"variable":[]}},"response":[],"_postman_id":"89c5d6cd-3d2c-4d53-877d-cb38b1d2ed86"},{"name":"Get Followup Schedule","id":"c513461b-c61b-4acd-8fa1-84f8b5b33fea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.spark.re/v2/followup-schedules/:id","auth":{"type":"apikey","apikey":{"value":"Required. Enter a single ID
\n","type":"text/plain"},"type":"string","value":"","key":"id"}]}},"response":[],"_postman_id":"c513461b-c61b-4acd-8fa1-84f8b5b33fea"}],"id":"350aacaa-34be-4e66-bc77-fd5f55423444","description":"A followup schedule is used to assign follow up tasks to a given contact.
\n","_postman_id":"350aacaa-34be-4e66-bc77-fd5f55423444","auth":{"type":"apikey","apikey":{"value":"[integer] Which page of results to return
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"[integer] The number of results returned per page. Defaults to 25
\n","type":"text/plain"},"key":"per_page","value":"25"},{"disabled":true,"description":{"content":"[string] Provide a field name to change the sort order. Defaults to created_at
\n","type":"text/plain"},"key":"order","value":"created_at"},{"disabled":true,"description":{"content":"[string] Accepts asc or desc. Defaults to desc
\n","type":"text/plain"},"key":"direction","value":"desc"},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"created_at_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"value_#","value":""},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"updated_at_#","value":""}],"variable":[]}},"response":[],"_postman_id":"2ed32568-adfd-44d5-8d17-bdbd6b2f371d"},{"name":"Get Interaction Type","id":"9314a510-ea70-4dfb-a2a7-d3e5cefe3d45","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.spark.re/v2/interaction-types/:id","auth":{"type":"apikey","apikey":{"value":"Required. Enter a single ID
\n","type":"text/plain"},"type":"string","value":"","key":"id"}]}},"response":[],"_postman_id":"9314a510-ea70-4dfb-a2a7-d3e5cefe3d45"}],"id":"b0585038-5872-4c7f-a8ff-d3c0d623ff11","description":"An interaction type is used to classify interactions.
\n","_postman_id":"b0585038-5872-4c7f-a8ff-d3c0d623ff11","auth":{"type":"apikey","apikey":{"value":"[integer] Which page of results to return
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"[integer] The number of results returned per page. Defaults to 25
\n","type":"text/plain"},"key":"per_page","value":"25"},{"disabled":true,"description":{"content":"[string] Provide a field name to change the sort order. Defaults to created_at
\n","type":"text/plain"},"key":"order","value":"created_at"},{"disabled":true,"description":{"content":"[string] Accepts asc or desc. Defaults to desc
\n","type":"text/plain"},"key":"direction","value":"desc"},{"disabled":true,"description":{"content":"[integer]
\n","type":"text/plain"},"key":"contact_id_#","value":""},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"created_at_#","value":""},{"disabled":true,"description":{"content":"[integer] The team member that created the interaction
\n","type":"text/plain"},"key":"creator_id_#","value":""},{"disabled":true,"description":{"content":"[integer]
\n","type":"text/plain"},"key":"interaction_type_id_#","value":""},{"disabled":true,"description":{"content":"[integer] The team member assigned to the interaction.
\n","type":"text/plain"},"key":"team_member_id_#","value":""},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"timestamp_#","value":""},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"updated_at_#","value":""}],"variable":[]}},"response":[],"_postman_id":"c7401ec7-ef25-4d3e-acfb-5c8333df9712"},{"name":"Get Interaction","id":"0d466a8b-d45b-40b0-aaff-1d6cef2565eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.spark.re/v2/interactions/:id","auth":{"type":"apikey","apikey":{"value":"Required. Enter a single ID
\n","type":"text/plain"},"type":"string","value":"","key":"id"}]}},"response":[],"_postman_id":"0d466a8b-d45b-40b0-aaff-1d6cef2565eb"},{"name":"Create Interaction","id":"7a433549-e7d4-445e-9214-4223fce438f5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n // Contact who was interacted with\n // See \"Contacts\" for IDs\n \"contact_id\": ,\n\n // Type of event taking place\n // See \"Interaction Types\" for IDs\n \"interaction_type_id\": ,\n \n // Description of the interaction or any followup notes\n \"note\": \"Business-focused homogeneous utilisation\",\n\n // Team member who did the interaction\n // See \"Team Members\" for IDs\n \"team_member_id\": ,\n\n // Datetime the interaction took place\n \"timestamp\": \"2026-06-14T09:39:32.213Z\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.spark.re/v2/interactions","description":"Note: The create endpoint does not work with a company API key.
\nA POST request to create a new contact. A contact_id, interaction_type_id, team_member_id, and timestamp are required to create a new interaction although we recommended you include as much information as you have available.
\nSee the POST /v2/interactions (Create Interaction) Body for a list of available fields, and the expected format for submitting values.
An interaction is logged by team members when engaging with a contact via email, phone, in person or virtually.
\n","_postman_id":"ee5c1dd5-c83d-4b3e-aebf-6e6bffdfe9ee","auth":{"type":"apikey","apikey":{"value":"[integer] Which page of results to return
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"[integer] The number of results returned per page. Defaults to 25
\n","type":"text/plain"},"key":"per_page","value":"25"},{"disabled":true,"description":{"content":"[string] Provide a field name to change the sort order. Defaults to created_at
\n","type":"text/plain"},"key":"order","value":"created_at"},{"disabled":true,"description":{"content":"[string] Accepts asc or desc. Defaults to desc
\n","type":"text/plain"},"key":"direction","value":"desc"},{"disabled":true,"description":{"content":"[integer]
\n","type":"text/plain"},"key":"contact_id_#","value":""},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"created_at_#","value":""},{"disabled":true,"description":{"content":"[integer]
\n","type":"text/plain"},"key":"contract_id_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"description_#","value":""},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"due_date_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"name_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"status_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"team_member_id_#","value":""},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"updated_at_#","value":""}],"variable":[]}},"response":[],"_postman_id":"849f7372-a5de-45fb-86bb-8eb9b13b16d2"},{"name":"Get Internal Commission","id":"b4a1a60c-a918-4d74-bf09-5aaba194a4c0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.spark.re/v2/internal-commissions/:id","auth":{"type":"apikey","apikey":{"value":"Required. Enter a single ID
\n","type":"text/plain"},"type":"string","value":"","key":"id"}]}},"response":[],"_postman_id":"b4a1a60c-a918-4d74-bf09-5aaba194a4c0"}],"id":"a378a68b-454a-4660-b4ee-eb93485a8e3a","description":"An internal commission is a monitary amount paid to a team member after a successful real estate sale.
\n","_postman_id":"a378a68b-454a-4660-b4ee-eb93485a8e3a","auth":{"type":"apikey","apikey":{"value":"[integer] Which page of results to return
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"[integer] The number of results returned per page. Defaults to 25
\n","type":"text/plain"},"key":"per_page","value":"25"},{"disabled":true,"description":{"content":"[string] Provide a field name to change the sort order. Defaults to created_at
\n","type":"text/plain"},"key":"order","value":"created_at"},{"disabled":true,"description":{"content":"[string] Accepts asc or desc. Defaults to desc
\n","type":"text/plain"},"key":"direction","value":"desc"},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"created_at_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"value_#","value":""},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"updated_at_#","value":""}],"variable":[]}},"response":[],"_postman_id":"27c81b94-fc14-4b17-97ff-451aa8eddb2b"},{"name":"Get Inventory Status","id":"14e0afd6-8236-45da-9ca7-51436b1a1b52","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.spark.re/v2/inventory-statuses/:id","auth":{"type":"apikey","apikey":{"value":"Required. Enter a single ID
\n","type":"text/plain"},"type":"string","value":"","key":"id"}]}},"response":[],"_postman_id":"14e0afd6-8236-45da-9ca7-51436b1a1b52"}],"id":"7520004e-4ad3-4fb8-bb93-c5bb71f0301f","description":"An inventory status that is assigned to a unit (inventory) either manually, or automatically when a reservation/contract is written.
\n","_postman_id":"7520004e-4ad3-4fb8-bb93-c5bb71f0301f","auth":{"type":"apikey","apikey":{"value":"[integer] Which page of results to return
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"[integer] The number of results returned per page. Defaults to 25
\n","type":"text/plain"},"key":"per_page","value":"25"},{"disabled":true,"description":{"content":"[string] Provide a field name to change the sort order. Defaults to created_at
\n","type":"text/plain"},"key":"order","value":"created_at"},{"disabled":true,"description":{"content":"[string] Accepts asc or desc. Defaults to desc
\n","type":"text/plain"},"key":"direction","value":"desc"},{"disabled":true,"description":{"content":"[integer]
\n","type":"text/plain"},"key":"area_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"bathrooms_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"bedrooms_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"building_#","value":""},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"created_at_#","value":""},{"disabled":true,"description":{"content":"[integer]
\n","type":"text/plain"},"key":"floor_#","value":""},{"disabled":true,"description":{"content":"[integer]
\n","type":"text/plain"},"key":"floorplan_id_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"kind_#","value":""},{"disabled":true,"description":{"content":"[boolean]
\n","type":"text/plain"},"key":"lease_#","value":""},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"offer_at_#","value":""},{"disabled":true,"description":{"content":"[integer]
\n","type":"text/plain"},"key":"price_#","value":""},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"sold_at_#","value":""},{"disabled":true,"description":{"content":"[integer]
\n","type":"text/plain"},"key":"status_id_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"status_value_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"unit_#","value":""},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"updated_at_#","value":""}],"variable":[]}},"response":[],"_postman_id":"ae33814a-bfa0-4c29-9a32-b62e703cdc42"},{"name":"Get Inventory Unit","id":"145965ed-0778-47cd-84a0-5acd0b9d3c1a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.spark.re/v2/inventory/:id","auth":{"type":"apikey","apikey":{"value":"Required. Enter a single ID
\n","type":"text/plain"},"type":"string","value":"","key":"id"}]}},"response":[],"_postman_id":"145965ed-0778-47cd-84a0-5acd0b9d3c1a"}],"id":"94afcbc6-ed1b-4416-bea5-55fa094a6546","description":"Inventory are units available in a building or project.
\n","_postman_id":"94afcbc6-ed1b-4416-bea5-55fa094a6546","auth":{"type":"apikey","apikey":{"value":"[integer] Which page of results to return
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"[integer] The number of results returned per page. Defaults to 25
\n","type":"text/plain"},"key":"per_page","value":"25"},{"disabled":true,"description":{"content":"[string] Provide a field name to change the sort order. Defaults to created_at
\n","type":"text/plain"},"key":"order","value":"created_at"},{"disabled":true,"description":{"content":"[string] Accepts asc or desc. Defaults to desc
\n","type":"text/plain"},"key":"direction","value":"desc"},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"city_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"country_iso_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"country_name_#","value":""},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"created_at_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"name_#","value":""},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"updated_at_#","value":""}],"variable":[]}},"response":[],"_postman_id":"7507a440-a484-46a9-b64f-ef90ce89564e"},{"name":"Get Legal Firm","id":"adbbdb74-1b7c-4dce-9e87-4b80b564a903","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.spark.re/v2/legal-firms/:id","auth":{"type":"apikey","apikey":{"value":"Required. Enter a single ID
\n","type":"text/plain"},"type":"string","value":"","key":"id"}]}},"response":[],"_postman_id":"adbbdb74-1b7c-4dce-9e87-4b80b564a903"},{"name":"Create Legal Firm","event":[{"listen":"prerequest","script":{"id":"21bf38e1-b73b-4ac9-bbb6-bd2fb169783a","exec":[""],"type":"text/javascript"}}],"id":"f0d4e409-29be-496c-aa49-13b31b909339","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n // Street address where this legal firm is located\n \"address_line_1\": \"26124 Haley Camp\",\n\n // Additional street address where this legal firm is located\n // Usually suite, unit, or flat number\n \"address_line_2\": \"Unit 101\",\n\n // The city where the legal firm is located\n \"city\": \"South Kendricktown\",\n\n // Country where this legal firm is located\n // Mutually exclusive with country_name\n \"country_iso\": \"{{iso-of-random-countries-result}}\",\n \n // Country where this legal firm is located\n // Mutually exclusive with country_iso\n \"country_name\": \"Canada\",\n\n // Email address for the legal firm\n // Usually for general inquires or support\n \"email\": \"Alden_Gorczany@example.net\",\n\n // Fax number for the legal firm\n \"fax\": \"959-616-0914\",\n\n // Name of the legal firm\n \"name\": \"Rowe Inc\",\n\n // Phone number of the legal firm\n // Email or phone are required\n \"phone\": \"622-839-3983\",\n\n // Postal/zip code of where the legal firm is located\n \"postcode\": \"683\",\n\n // Province/state where the legal firm is located\n \"province\": \"Avon\",\n\n // Website for the legal firm\n // Should include http:// or https://\n \"website\": \"https://www.example.com\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://api.spark.re/v2/legal-firms","description":"A POST request to create a new brokerage. Only a name is required to create a new legal firm although we recommended you include as much information as you have available.
\nSee the POST /v2/legal-firms (Create Legal Firm) Body for a list of available fields, and the expected format for submitting values.
[integer] Which page of results to return
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"[integer] The number of results returned per page. Defaults to 25
\n","type":"text/plain"},"key":"per_page","value":"25"},{"disabled":true,"description":{"content":"[string] Provide a field name to change the sort order. Defaults to created_at
\n","type":"text/plain"},"key":"order","value":"created_at"},{"disabled":true,"description":{"content":"[string] Accepts asc or desc. Defaults to desc
\n","type":"text/plain"},"key":"direction","value":"desc"},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"created_at_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"name_#","value":""},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"updated_at_#","value":""}],"variable":[]}},"response":[],"_postman_id":"9cfdef7b-0cab-4ebb-ae73-3af8698fdf5c"},{"name":"Get Lender","id":"5f7a4e25-0587-49cf-9dce-e8a39d147254","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.spark.re/v2/lenders/:id","auth":{"type":"apikey","apikey":{"value":"Required. Enter a single ID
\n","type":"text/plain"},"type":"string","value":"","key":"id"}]}},"response":[],"_postman_id":"5f7a4e25-0587-49cf-9dce-e8a39d147254"}],"id":"deb36397-cec6-4ad5-88ef-9fe475876a0f","description":"A lender is an organization or person who lends money.
\n","_postman_id":"deb36397-cec6-4ad5-88ef-9fe475876a0f","auth":{"type":"apikey","apikey":{"value":"[integer] Which page of results to return
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"[integer] The number of results returned per page. Defaults to 25
\n","type":"text/plain"},"key":"per_page","value":"25"},{"disabled":true,"description":{"content":"[string] Provide a field name to change the sort order. Defaults to created_at
\n","type":"text/plain"},"key":"order","value":"created_at"},{"disabled":true,"description":{"content":"[string] Accepts asc or desc. Defaults to desc
\n","type":"text/plain"},"key":"direction","value":"desc"},{"disabled":true,"description":{"content":"[integer]
\n","type":"text/plain"},"key":"contact_id_#","value":""},{"disabled":true,"description":{"content":"[integer]
\n","type":"text/plain"},"key":"contract_id_#","value":""},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"created_at_#","value":""},{"disabled":true,"description":{"content":"[integer]
\n","type":"text/plain"},"key":"interaction_id_#","value":""},{"disabled":true,"description":{"content":"[integer]
\n","type":"text/plain"},"key":"inventory_id_#","value":""},{"disabled":true,"description":{"content":"[integer]
\n","type":"text/plain"},"key":"team_member_id_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"text_#","value":""},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"updated_at_#","value":""}],"variable":[]}},"response":[],"_postman_id":"bdc25a4e-e773-4b48-8791-a6f904133562"},{"name":"Get Note","id":"8be31c3a-142a-4012-a4f5-3ce9b5b0916e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.spark.re/v2/notes/:id","auth":{"type":"apikey","apikey":{"value":"Required. Enter a single ID
\n","type":"text/plain"},"type":"string","value":"","key":"id"}]}},"response":[],"_postman_id":"8be31c3a-142a-4012-a4f5-3ce9b5b0916e"},{"name":"Create Note","id":"9f328f8b-b973-4e5b-a918-df0d7877f3b9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n // Contact to store the note on\n // See \"Contacts\" for IDs\n // \"contact_id\": ,\n\n // Contract to store the note on\n // See \"Contracts\" for IDs\n // \"contract_id\": ,\n\n // Interaction to store the note on\n // See \"Interactions\" for IDs\n // \"interaction_id\": ,\n\n // Inventory to store the note on\n // See \"Inventory\" for IDs\n // \"inventory_id\": ,\n\n // Team member who is creating the note\n // See \"Team Members\" for IDs\n // \"team_member_id\": ,\n\n // Text or copy for the note\n // \"text\": \"Function-based multi-state toolset\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.spark.re/v2/notes","description":"Note: The create endpoint does not work with a company API key.
\nA POST request to create a new note. The notes text and a team_member_id, along with any one of contact_id, contract_id, interaction_id, or inventory_id are required to create a new note.
\nSee the POST /v2/notes (Create Note) Body for a list of available fields, and the expected format for submitting values.
A note is used by team members to log specific details about an contact, interaction, inventory, contract, or reservation.
\n","_postman_id":"7239935b-bcca-4dbf-8e0f-5b3116800bed","auth":{"type":"apikey","apikey":{"value":"[integer] Which page of results to return
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"[integer] The number of results returned per page. Defaults to 25
\n","type":"text/plain"},"key":"per_page","value":"25"},{"disabled":true,"description":{"content":"[string] Provide a field name to change the sort order. Defaults to created_at
\n","type":"text/plain"},"key":"order","value":"created_at"},{"disabled":true,"description":{"content":"[string] Accepts asc or desc. Defaults to desc
\n","type":"text/plain"},"key":"direction","value":"desc"},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"building_#","value":""},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"created_at_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"floor_#","value":""},{"disabled":true,"description":{"content":"[integer]
\n","type":"text/plain"},"key":"inventory_id_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"name_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"number_#","value":""},{"disabled":true,"description":{"content":"[integer]
\n","type":"text/plain"},"key":"status_id_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"status_value_#","value":""},{"disabled":true,"description":{"content":"[integer]
\n","type":"text/plain"},"key":"type_id_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"type_size_#","value":""},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"updated_at_#","value":""}],"variable":[]}},"response":[],"_postman_id":"fe3b6ef8-4e11-482f-bdda-c9d64505097a"},{"name":"Get Parking Stall","id":"613537c2-4eb7-4320-b861-f7c10e9dab25","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.spark.re/v2/parking-stalls/:id","auth":{"type":"apikey","apikey":{"value":"Required. Enter a single ID
\n","type":"text/plain"},"type":"string","value":"","key":"id"}]}},"response":[],"_postman_id":"613537c2-4eb7-4320-b861-f7c10e9dab25"}],"id":"d4aff2f7-371c-4052-a075-fde7921bdb7f","description":"A parking stall is an add-on for a unit (inventory) on a contract or reservation.
\n","_postman_id":"d4aff2f7-371c-4052-a075-fde7921bdb7f","auth":{"type":"apikey","apikey":{"value":"[integer] Which page of results to return
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"[integer] The number of results returned per page. Defaults to 25
\n","type":"text/plain"},"key":"per_page","value":"25"},{"disabled":true,"description":{"content":"[string] Provide a field name to change the sort order. Defaults to created_at
\n","type":"text/plain"},"key":"order","value":"created_at"},{"disabled":true,"description":{"content":"[string] Accepts asc or desc. Defaults to desc
\n","type":"text/plain"},"key":"direction","value":"desc"},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"created_at_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"country_iso_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"country_name_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"kind_#","value":""},{"disabled":true,"description":{"content":"[boolean]
\n","type":"text/plain"},"key":"lease_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"name_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"province_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"sales_stage_#","value":""},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"start_date_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"state_#","value":""},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"updated_at_#","value":""}],"variable":[]}},"response":[],"_postman_id":"3064c37d-7f4a-4176-aa23-8a350667c65a"},{"name":"Get Project","id":"cd09d3de-4317-41e6-8570-608fe2941977","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.spark.re/v2/projects/:id","auth":{"type":"apikey","apikey":{"value":"Required. Enter a single ID
\n","type":"text/plain"},"type":"string","value":"","key":"id"}]}},"response":[],"_postman_id":"cd09d3de-4317-41e6-8570-608fe2941977"}],"id":"cae795b0-1112-4b47-b375-e34cb26fad5e","description":"A project is an indivdual development, usually a single building that is being sold or leased.
\n","_postman_id":"cae795b0-1112-4b47-b375-e34cb26fad5e","auth":{"type":"apikey","apikey":{"value":"[integer] Which page of results to return
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"[integer] The number of results returned per page. Defaults to 25
\n","type":"text/plain"},"key":"per_page","value":"25"},{"disabled":true,"description":{"content":"[string] Provide a field name to change the sort order. Defaults to created_at
\n","type":"text/plain"},"key":"order","value":"created_at"},{"disabled":true,"description":{"content":"[string] Accepts asc or desc. Defaults to desc
\n","type":"text/plain"},"key":"direction","value":"desc"},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"created_at_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"question_#","value":""},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"updated_at_#","value":""}],"variable":[]}},"response":[],"_postman_id":"f3d03028-4bb7-4c8b-aadf-b50fd19242b3"},{"name":"Get Question","id":"77aadfc5-8131-4443-9c37-7d68533f2082","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.spark.re/v2/questions/:id","auth":{"type":"apikey","apikey":{"value":"Required. Enter a single ID
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"77aadfc5-8131-4443-9c37-7d68533f2082"}],"id":"9b5f9bad-ddd4-43dc-b5df-47ac17563cb5","description":"A question can be answered by a contact, usually through a registration form, a visit to a sales center, or via some other form of communication. They are often used to track information about what a contact is interested in purchasing, their budget, or when they'd like to purchase.
\n","event":[{"listen":"prerequest","script":{"id":"8bd40226-a4c2-4d67-bba9-eb619fbe61f5","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f5dda8d4-a5b9-42ad-977a-f8a7e1ea81d3","type":"text/javascript","exec":[""]}}],"_postman_id":"9b5f9bad-ddd4-43dc-b5df-47ac17563cb5","auth":{"type":"apikey","apikey":{"value":"[integer] Which page of results to return
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"[integer] The number of results returned per page. Defaults to 25
\n","type":"text/plain"},"key":"per_page","value":"25"},{"disabled":true,"description":{"content":"[string] Provide a field name to change the sort order. Defaults to created_at
\n","type":"text/plain"},"key":"order","value":"created_at"},{"disabled":true,"description":{"content":"[string] Accepts asc or desc. Defaults to desc
\n","type":"text/plain"},"key":"direction","value":"desc"},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"created_at_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"question_#","value":""},{"disabled":true,"description":{"content":"[integer]
\n","type":"text/plain"},"key":"question_id_#","value":""},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"updated_at_#","value":""}],"variable":[]}},"response":[],"_postman_id":"6c7f3baf-974d-444d-9430-a3e6521b52a9"},{"name":"Get Question Answer","id":"1882fc4a-d9be-42ef-ae35-1912857a6284","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.spark.re/v2/question-answers/:id","auth":{"type":"apikey","apikey":{"value":"Required. Enter a single ID
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"1882fc4a-d9be-42ef-ae35-1912857a6284"}],"id":"2a130364-cf0a-473f-9585-26983fe85318","description":"A question that has been answered by a contact, usually through a registration form, a visit to a sales center, or via some other form of communication. They are often used to track information about what a contact is interested in purchasing, their budget, or when they'd like to purchase.
\n","event":[{"listen":"prerequest","script":{"id":"8bd40226-a4c2-4d67-bba9-eb619fbe61f5","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f5dda8d4-a5b9-42ad-977a-f8a7e1ea81d3","type":"text/javascript","exec":[""]}}],"_postman_id":"2a130364-cf0a-473f-9585-26983fe85318","auth":{"type":"apikey","apikey":{"value":"[integer] Which page of results to return
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"[integer] The number of results returned per page. Defaults to 25
\n","type":"text/plain"},"key":"per_page","value":"25"},{"disabled":true,"description":{"content":"[string] Provide a field name to change the sort order. Defaults to created_at
\n","type":"text/plain"},"key":"order","value":"created_at"},{"disabled":true,"description":{"content":"[string] Accepts asc or desc. Defaults to desc
\n","type":"text/plain"},"key":"direction","value":"desc"},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"created_at_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"category_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"name_#","value":""},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"updated_at_#","value":""}],"variable":[]}},"response":[],"_postman_id":"6bfdc16a-fd98-4258-9128-1bb0ea47ecb8"},{"name":"Get Registration Source","id":"0bad375e-318c-4880-8cfd-04d3cafb084a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.spark.re/v2/registration-sources/:id","auth":{"type":"apikey","apikey":{"value":"Required. Enter a single ID
\n","type":"text/plain"},"type":"string","value":"","key":"id"}]}},"response":[],"_postman_id":"0bad375e-318c-4880-8cfd-04d3cafb084a"}],"id":"cd1902d8-f8b8-4bb2-bf16-57ac17caf641","_postman_id":"cd1902d8-f8b8-4bb2-bf16-57ac17caf641","description":"","auth":{"type":"apikey","apikey":{"value":"[integer] Which page of results to return
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"[integer] The number of results returned per page. Defaults to 25
\n","type":"text/plain"},"key":"per_page","value":"25"},{"disabled":true,"description":{"content":"[string] Provide a field name to change the sort order. Defaults to created_at
\n","type":"text/plain"},"key":"order","value":"created_at"},{"disabled":true,"description":{"content":"[string] Accepts asc or desc. Defaults to desc
\n","type":"text/plain"},"key":"direction","value":"desc"},{"disabled":true,"description":{"content":"[integer]
\n","type":"text/plain"},"key":"contract_id_#","value":""},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"converted_at_#","value":""},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"created_at_#","value":""},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"executed_at_#","value":""},{"disabled":true,"description":{"content":"[integer]
\n","type":"text/plain"},"key":"inventory_id_#","value":""},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"reserved_at_#","value":""},{"disabled":true,"description":{"content":"[integer]
\n","type":"text/plain"},"key":"status_id_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"status_value_#","value":""},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"updated_at_#","value":""}],"variable":[]}},"response":[],"_postman_id":"33986f4e-eace-4eee-8c4d-cc5f2072b4dd"},{"name":"Get Reservation","id":"eb2a24d7-9466-4f2f-b205-a4403a8a6e78","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.spark.re/v2/reservations/:id","description":"A GET request to find a contact by email.
\n","auth":{"type":"apikey","apikey":{"value":"Required. Enter a single ID
\n","type":"text/plain"},"type":"string","value":"","key":"id"}]}},"response":[],"_postman_id":"eb2a24d7-9466-4f2f-b205-a4403a8a6e78"}],"id":"c5ce1a0f-90cf-462d-bc24-6325b819b52f","_postman_id":"c5ce1a0f-90cf-462d-bc24-6325b819b52f","description":"","auth":{"type":"apikey","apikey":{"value":"[integer] Which page of results to return
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"[integer] The number of results returned per page. Defaults to 25
\n","type":"text/plain"},"key":"per_page","value":"25"},{"disabled":true,"description":{"content":"[string] Provide a field name to change the sort order. Defaults to created_at
\n","type":"text/plain"},"key":"order","value":"created_at"},{"disabled":true,"description":{"content":"[string] Accepts asc or desc. Defaults to desc
\n","type":"text/plain"},"key":"direction","value":"desc"},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"created_at_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"name_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"type_#","value":""},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"updated_at_#","value":""}],"variable":[]}},"response":[],"_postman_id":"c5f2dbb3-fb47-4162-8332-c9172f110502"},{"name":"Get Standardized Field","id":"eec97a87-3cf7-4219-b069-c7134d0a03f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.spark.re/v2/standardized-fields/:id","auth":{"type":"apikey","apikey":{"value":"Required. Enter a single ID
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"eec97a87-3cf7-4219-b069-c7134d0a03f0"}],"id":"15e21f3e-eb1b-4ee7-adfd-3c62dbacaadb","description":"An standardized field is a non Spark default, custom field that can be used with contacts, contracts, inventory, reservations, and team members.
\nAn additional field on a object (like contacts) can either be associated with a standardized field, or can be a one off value.
\n","event":[{"listen":"prerequest","script":{"id":"8bd40226-a4c2-4d67-bba9-eb619fbe61f5","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f5dda8d4-a5b9-42ad-977a-f8a7e1ea81d3","type":"text/javascript","exec":[""]}}],"_postman_id":"15e21f3e-eb1b-4ee7-adfd-3c62dbacaadb","auth":{"type":"apikey","apikey":{"value":"[integer] Which page of results to return
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"[integer] The number of results returned per page. Defaults to 25
\n","type":"text/plain"},"key":"per_page","value":"25"},{"disabled":true,"description":{"content":"[string] Provide a field name to change the sort order. Defaults to created_at
\n","type":"text/plain"},"key":"order","value":"created_at"},{"disabled":true,"description":{"content":"[string] Accepts asc or desc. Defaults to desc
\n","type":"text/plain"},"key":"direction","value":"desc"},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"building_#","value":""},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"created_at_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"floor_#","value":""},{"disabled":true,"description":{"content":"[integer]
\n","type":"text/plain"},"key":"inventory_id_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"location_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"name_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"number_#","value":""},{"disabled":true,"description":{"content":"[integer]
\n","type":"text/plain"},"key":"status_id_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"status_value_#","value":""},{"disabled":true,"description":{"content":"[integer]
\n","type":"text/plain"},"key":"type_id_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"type_size_#","value":""},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"updated_at_#","value":""}],"variable":[]}},"response":[],"_postman_id":"0c6e57b3-a68d-4f18-a031-a75afdcc9944"},{"name":"Get Storage Unit","id":"60252888-152d-4b46-9135-4b2cba9e780e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.spark.re/v2/storage-unit/:id","auth":{"type":"apikey","apikey":{"value":"Required. Enter a single ID
\n","type":"text/plain"},"type":"string","value":"","key":"id"}]}},"response":[],"_postman_id":"60252888-152d-4b46-9135-4b2cba9e780e"}],"id":"42cb5c45-5b83-4c22-b26c-54b6779b11e4","description":"A storage unit is an add on for a unit (inventory) on a contract or reservation.
\n","_postman_id":"42cb5c45-5b83-4c22-b26c-54b6779b11e4","auth":{"type":"apikey","apikey":{"value":"[integer] Which page of results to return
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"[integer] The number of results returned per page. Defaults to 25
\n","type":"text/plain"},"key":"per_page","value":"25"},{"disabled":true,"description":{"content":"[string] Provide a field name to change the sort order. Defaults to created_at
\n","type":"text/plain"},"key":"order","value":"created_at"},{"disabled":true,"description":{"content":"[string] Accepts asc or desc. Defaults to desc
\n","type":"text/plain"},"key":"direction","value":"desc"},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"created_at_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"email_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"first_name_#","value":""},{"disabled":true,"description":{"content":"[string]
\n","type":"text/plain"},"key":"last_name_#","value":""},{"disabled":true,"description":{"content":"[datetime]
\n","type":"text/plain"},"key":"updated_at_#","value":""}],"variable":[]}},"response":[],"_postman_id":"f73ad373-bca4-48b1-9a00-29726c8ffb33"},{"name":"Get Team Member","id":"c5256179-140a-4c28-bc7e-85e28c90cfa5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.spark.re/v2/team-members/:id","auth":{"type":"apikey","apikey":{"value":"Required. Enter a single ID
\n","type":"text/plain"},"type":"string","value":"","key":"id"}]}},"response":[],"_postman_id":"c5256179-140a-4c28-bc7e-85e28c90cfa5"}],"id":"770b717f-f2e5-41ab-a708-08a6ab52820e","description":"A user, or team member as they are referred to in Spark has access to the application, and takes actions on the various resources.
\n","_postman_id":"770b717f-f2e5-41ab-a708-08a6ab52820e","auth":{"type":"apikey","apikey":{"value":"Spark's new API released in 2023, v2 is a complete rewrite from the ground up and gives access to more data than ever before.
\n","event":[{"listen":"prerequest","script":{"id":"5148b053-bbc2-4308-b6db-a010492140c4","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b2b1b7d5-cc7b-4b35-ab71-caffd8e6c99f","type":"text/javascript","exec":["// Extract the current request type from the url path","// Example: /v2/contacts -> contacts","const requestEndpoint = pm.request.url.path[1];","","// Set the expected status code based on the request method","const requestStatus = pm.request.method == \"POST\" ? 201 : 200;","","pm.test(`Status code is ${requestStatus}`, function () {"," pm.response.to.have.status(requestStatus);","});","","pm.test(\"Response should be json\", function () {"," pm.response.to.be.json;","});","","// Sets a \"id-of-first-*-result\" collection variable to ensure that the ","// documentation renders correctly. If this variable is not present in collection ","// or environment variables, they are rendered as {{id-of-first-*-result}} in the ","// documentation. When new data types are added, these can be quickly set by ","// running the entire collection.","pm.collectionVariables.set(`id-of-first-${requestEndpoint}-result`, null);","","// The following endpoints do not return ids","const requestsToSkip = [\"countries\"];","","if(!requestsToSkip.includes(requestEndpoint)) {"," pm.test(\"Response should include an ID\", function () {"," jsonData = pm.response.json();",""," // Depending on the request endpoint either an array, or a json object"," // are returned. Simply return the first object, or that object."," firstResult = jsonData[0] ? jsonData[0] : jsonData;",""," if(idOfFirstResult = firstResult.id){"," pm.expect(idOfFirstResult).to.exist;",""," // Store a \"id-of-first-*-result\" environment variable, which is used "," // in other requests for easily submitting referenced ids"," pm.environment.set(`id-of-first-${requestEndpoint}-result`, idOfFirstResult);"," }"," });","}"]}}],"_postman_id":"4329ab85-20d9-4bc2-bb51-ec9d47905107","auth":{"type":"apikey","apikey":{"value":"A POST request to create a new contact. Only an email is required to create a new contact although we recommended you include as much information as you have available.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"4cee5542-6551-49f3-89b0-e9d5b9686005","id":"4cee5542-6551-49f3-89b0-e9d5b9686005","name":"Forms","type":"folder"}},"urlObject":{"path":["{{registration-form-path}}"],"host":["https://spark.re"],"query":[{"key":"agent","value":"false"},{"disabled":true,"key":"answers[][answers]","value":""},{"disabled":true,"key":"contact[address_line_1]","value":"511 Marc Harbors"},{"disabled":true,"key":"contact[address_line_2]","value":""},{"disabled":true,"key":"contact[brokerage_name]","value":"Powlowski LLC"},{"disabled":true,"key":"contact[city]","value":"South Vivienneberg"},{"key":"contact[comments]","value":"Monitored bandwidth-monitored encoding"},{"disabled":true,"key":"contact[contact_preference]","value":""},{"disabled":true,"key":"contact[country_id]","value":"361"},{"key":"contact[email]","value":"Claude_Gibson@example.com"},{"disabled":true,"key":"contact[employer]","value":"Metrics"},{"key":"contact[first_name]","value":"Mariah"},{"disabled":true,"key":"contact[job_title]","value":"Global Directives Assistant"},{"key":"contact[last_name]","value":"Shields"},{"disabled":true,"key":"contact[phone]","value":"459-756-4031"},{"disabled":true,"key":"contact[postcode]","value":""},{"disabled":true,"key":"contact[province]","value":""},{"disabled":true,"key":"dynamic_attributes[][dynamic_attribute_id]","value":""},{"disabled":true,"key":"dynamic_attributes[][key]","value":""},{"disabled":true,"key":"dynamic_attributes[][value]","value":""},{"disabled":true,"key":"g-recaptcha-response","value":""},{"disabled":true,"key":"redirect_error","value":""},{"disabled":true,"key":"redirect_success","value":""},{"key":"source","value":"innovative"},{"key":"tracking_cookie_id","value":"e22fd431-e8e2-4ab0-a8d9-0216a62a7a71"},{"key":"tracking_page_url","value":"http%3A%2F%2Flocalhost%3A8000%2Fon-site-form.html%3Frun%3Da2e307d1-5914-4dd1-897a-0fc67e35a5ae"},{"key":"tracking_referrer","value":"http%3A%2F%2Flocalhost%3A8000%2F%3Fref%3DVermont"},{"key":"tracking_initial_landing_url","value":"http%3A%2F%2Flocalhost%3A8000%2Fon-site-form.html%3Fts%3D1781429972"},{"key":"tracking_initial_referrer","value":"http%3A%2F%2Flocalhost%3A8000%2F%3Fsrc%3DSaint"},{"key":"tracking_utm_source","value":"adapter"},{"key":"tracking_utm_medium","value":"Fish"},{"key":"tracking_utm_campaign","value":"matrices program Small calculate"},{"key":"tracking_utm_term","value":"Engineer"},{"key":"tracking_utm_content","value":"f"}],"variable":[]}},"response":[],"_postman_id":"53e63f2a-d93e-42db-abea-74ba73c5c635"}],"id":"4cee5542-6551-49f3-89b0-e9d5b9686005","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"d48c419c-9c2a-4c8f-b64a-1aa6377c74a8","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"fb4a1eef-1f2a-4e90-9a4f-d88a5f2022fc","type":"text/javascript","exec":["pm.test(\"Status code is 201\", function () {"," pm.response.to.have.status(201);","});"]}}],"_postman_id":"4cee5542-6551-49f3-89b0-e9d5b9686005","description":""},{"name":"Tracking Events","item":[{"name":"Link Click","id":"0bc13bb8-c10b-47be-83cd-cffbde706a37","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://spark.re/{{tracking-event-path}}?cookie_id={{tracking_cookie_id}}&event_type=link_click&occurred_at=2026-06-14T09:39:32.218Z&url=https://spark.re/{{registration-form-path}}%3Frun%3D694509f1-7139-4ef5-bcf6-18f68690c132&page_url=https://spark.re/{{registration-form-path}}%3Frun%3Dab29960e-9c8b-461d-9fb7-4cd6f3131587&data[clicked_url]=https://spark.re%2Fsome-target%3Fcta%3Dbi-directional&data[link_text]=Pants alarm Shoes Buckinghamshire","auth":{"type":"apikey","apikey":{"value":"For API integrations where a client hosts their own HTML form, Spark can associate website activity (page views and link clicks) with contacts created through POST /v2/contacts.
This section applies to standard HTML form submissions (no AJAX).
\nSpark supports 2 common contact creation flows for hosted forms:
\nCreate contacts through:
\nPOST /v2/contactsThis flow requires your backend to call the API with an Authorization token.
\nWhen creating contacts via POST /v2/contacts, you can include the same tracking params used by the tracking flow.
Supported params:
\ntracking_cookie_id
tracking_page_url
tracking_referrer
tracking_utm_source
tracking_utm_medium
tracking_utm_campaign
tracking_utm_term
tracking_utm_content
Important: tracking_cookie_id is required to associate prior tracking events to the created contact.
Create contacts through the Spark registration form endpoint:
\nPOST /:company_id/:id/register
POST /:company_id/:id/register/:template_id
This flow uses the registration form payload and does not require exposing API keys in client-side code.
\nThe client page loads the Spark tracking script.
\nThe script sets/reads a tracking cookie and captures website tracking data.
\nThe form submits to the client's backend (or directly to Spark registration endpoint).
\nTracking fields are submitted with the contact payload.
\nSpark links the tracking activity to the created contact.
\nUse the correct Spark base URL for the environment where the form is running:
\nProduction base URL: https://spark.re
Demo base URL: https://demo.spark.re
If using demo, remember all domains are prefixed with demo as described in the Environments section.
Add this script tag to the hosted form page:
\n<script src=\"<spark_base_url>/tracking/script.js\" data-script-locator=\"tracking\" data-project-id=\"PROJECT_ID\" data-template-id=\"TEMPLATE_ID\" data-consent=\"true\" data-events-url=\"<spark_base_url>/<company_permalink>/<project_permalink>/tracking/events\"> </script>\n\nRequired attributes
\ndata-script-locator=\"tracking\"
\ndata-project-id
\ndata-template-id
\ndata-consent=\"true\"
\ndata-events-url
\nAdd the following hidden inputs to the HTML form, with the exact id and name values:
\n<input type=\"hidden\" id=\"tracking_cookie_id\" name=\"tracking_cookie_id\" /> \n<input type=\"hidden\" id=\"tracking_page_url\" name=\"tracking_page_url\" /> \n<input type=\"hidden\" id=\"tracking_referrer\" name=\"tracking_referrer\" /> \n<input type=\"hidden\" id=\"tracking_initial_landing_url\" name=\"tracking_initial_landing_url\" /> \n<input type=\"hidden\" id=\"tracking_initial_referrer\" name=\"tracking_initial_referrer\" /> \n<input type=\"hidden\" id=\"tracking_utm_source\" name=\"tracking_utm_source\" /> \n<input type=\"hidden\" id=\"tracking_utm_medium\" name=\"tracking_utm_medium\" /> \n<input type=\"hidden\" id=\"tracking_utm_campaign\" name=\"tracking_utm_campaign\" /> \n<input type=\"hidden\" id=\"tracking_utm_term\" name=\"tracking_utm_term\" /> \n<input type=\"hidden\" id=\"tracking_utm_content\" name=\"tracking_utm_content\" />\n\nWhen your backend receives the form submission, forward the tracking fields to Spark in the same POST /v2/contacts payload:
-tracking_cookie_id \n-tracking_page_url \n-tracking_referrer \n-tracking_utm_source \n-tracking_utm_medium \n-tracking_utm_campaign \n-tracking_utm_term \n-tracking_utm_content\n\nImportant: tracking_cookie_id is required to associate website activity with the created contact. If it is missing, contact creation can still succeed, but activity will not be linked.
Example Contact Create Request With Tracking
\ncurl --location 'https://api.spark.re/v2/contacts' \\\n--header 'Authorization: Token token=\"•••••••\"' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n\"email\": \"john@sparkreexample.com\",\n\"first_name\": \"John\",\n\"last_name\": \"Doe\",\n\"tracking_cookie_id\": \"d2b6f5c8-9b8a-4b7d-9f47-3e50df14f1c8\",\n\"tracking_page_url\": \"https://clientsite.com/register\",\n\"tracking_referrer\": \"https://google.com/\",\n\"tracking_utm_source\": \"google\",\n\"tracking_utm_medium\": \"cpc\",\n\"tracking_utm_campaign\": \"spring_launch\",\n\"tracking_utm_term\": \"new condo\",\n\"tracking_utm_content\": \"hero button\"\n}'\n\nTracking Events
\nSpark provides a public tracking endpoint that can be used to record website activity for a project.
\nThis endpoint supports 2 event types:
\npage_view
link_click
POST https://spark.re/:company_id/:id/tracking/events\n\nWhere:
\n:company_id is the company permalink
\n:id is the project permalink (or project id)
\nExample:
\nPOST https://spark.re/spark-inc/spark-village/tracking/eventsAuthorization
No API authorization header is required for this endpoint.
\nTracking events are accepted in both formats:
\nJSON request body (Content-Type: application/json)
\nURL/query parameters (form-style requests)
\nlanding_url
\nreferrer
\nutm_source
\nutm_medium
\nutm_campaign
\nutm_term
\nutm_content
\nRecords a website page view event associated with a tracked visitor cookie and links it to existing contact memberships in the target project.
\nEndpoint
\nPOST https://spark.re/{{tracking-event-path}}\n\nResolves to: POST /:company_id/:id/tracking/events
These parameters capture attribution data from the visitor's first session.
\nJSON example:
\ncurl --location 'https://spark.re/spark-inc/spark-village/tracking/events' \\\n --header 'Content-Type: application/json' \\\n --data-raw '{\n \"cookie_id\": \"d2b6f5c8-9b8a-4b7d-9f47-3e50df14f1c8\",\n \"event_type\": \"page_view\",\n \"occurred_at\": \"2026-03-06T18:20:00Z\",\n \"url\": \"https://clientsite.com/register\",\n \"page_url\": \"https://clientsite.com/register\",\n \"referrer\": \"https://google.com/\",\n \"initial_source\": {\n \"landing_url\": \"https://clientsite.com/register\",\n \"referrer\": \"https://google.com/\",\n \"utm_source\": \"google\",\n \"utm_medium\": \"cpc\",\n \"utm_campaign\": \"spring_launch\",\n \"utm_term\": \"new condo\",\n \"utm_content\": \"hero button\"\n }\n }'\n\nURL params example
\ncurl --location --request POST 'https://spark.re/spark-inc/spark-village/tracking/events?cookie_id=d2b6f5c8-9b8a-4b7d-9f47-3e50df14f1c8&event_type=page_view&occurred_at=2026-03-06T18:20:00Z&url=https://clientsite.com/register&page_url=https://clientsite.com/register&referrer=https://google.com/'\n\nResolves the project from the :company_id and :id route parameters.
Finds memberships in that project with a matching tracking_cookie_id.
Creates one or more tracking event records linked to those memberships.
\nIf occurred_at is missing or unparseable, the server substitutes the current timestamp.
The event_type value must be page_view for this endpoint. Use a separate request for other event types (e.g. link_click).
Both url and page_url are optional but strongly recommended for accurate analytics — url is the canonical form, while page_url reflects the exact URL seen by the visitor.
initial_source fields are only meaningful on a visitor's first tracked session and are typically ignored on subsequent events.
The data object accepts any arbitrary key-value pairs for custom event metadata.
All URL-valued parameters should be URL-encoded when passed as query string values.
\n204 No Content for accepted requests.
OPTIONS is supported for preflight (POST, OPTIONS).
Records a website link click associated with a tracked visitor cookie and matched memberships in the target project.
\nEndpoint
\nPOST https://spark.re/{{tracking-event-path}}\n\nResolves to: POST /:company_id/:id/tracking/events
Note: initial_source[...] fields are not required for link-click creation; they are only used to enrich membership source attribution when blank.
Resolves project from route params :company_id and :id.
Finds contact memberships in that project with tracking_cookie_id = cookie_id.
Creates tracking events for matched memberships.
\nCreates activity timeline event website_link_clicked with:
Clicked URL (data.clicked_url)
Page URL (url / page_url)
Link text (data.link_text)
If no membership matches the cookie, the request is is not returning error but no data is created
\nJSON example:
\ncurl --location 'https://spark.re/spark-inc/spark-village/tracking/events' \\\n --header 'Content-Type: application/json' \\\n --data-raw '{\n \"cookie_id\": \"d2b6f5c8-9b8a-4b7d-9f47-3e50df14f1c8\",\n \"event_type\": \"link_click\",\n \"occurred_at\": \"2026-03-06T18:21:00Z\",\n \"url\": \"https://clientsite.com/register\",\n \"page_url\": \"https://clientsite.com/register\",\n \"data\": {\n \"clicked_url\": \"https://clientsite.com/pricing\",\n \"link_text\": \"View Pricing\"\n }\n }'\n\nURL params ecample:
\ncurl --location --request POST 'https://spark.re/spark-inc/spark-village/tracking/events?cookie_id=d2b6f5c8-9b8a-4b7d-9f47-3e50df14f1c8&event_type=link_click&occurred_at=2026-03-06T18:21:00Z&url=https://clientsite.com/register&page_url=https://clientsite.com/register&data[clicked_url]=https://clientsite.com/pricing&data[link_text]=View Pricing'\n\n