Documentation: agents

All our Agents (Installers/Sales Agents)

To import data in this format you can use our API. -> API Documentation
Rate limit: 300 requests per minute. Once the limit is exceeded, any further requests will result in a 429 (Too Many Requests) response.

You can also supply us with files in xlsx, csv or json format. -> Example CSV

	Required	Type	p14n	Blurred	Autogenerated	Example
external_id The ID for the specific agent as tracked by the data provider (source)	✓	string	⤫	⤫	⤫	X98679862w
uid organization_id + data_origin + external_id	⤫	string	⤫	⤫	✓	a2ei-grid01
name The agents first and last name (p14)	⤫	string	✓	⤫	⤫	9d4e1e23bd5b727046a9e3b4b7db57bd8d6ee684
company The agents company	⤫	string	⤫	⤫	⤫	The sunny company
address The agents address (p14)	⤫	string	✓	⤫	⤫	9d4e1e23bd5b727046a9e3b4b7db57bd8d6ee684
email The agents email address (p14)	⤫	string	✓	⤫	⤫	7b1a3d34a3fcbad23308a5da7b49f9f3f7a67d2d
agent_type The agent type, either installer or sales agent	⤫	enum: sales_agent, installer	⤫	⤫	⤫	sales_agent
gender The agents gender, e.g. male, female, other, or unknown (null)	⤫	enum: M, F, O	⤫	⤫	⤫	M
phone The agents phone number (p14)	⤫	string	✓	⤫	⤫	7b1a3d34a3fcbad23308a5da7b49f9f3f7a67d2d
latitude The agents location latitude (blurred to 3 decimal points) Only period (.) decimal delimiters are supported. Do not use commas (,) — they will cause an error.	⤫	float	✓	✓	⤫	37.775
longitude The agents location longitude (blurred to 3 decimal points) Only period (.) decimal delimiters are supported. Do not use commas (,) — they will cause an error.	⤫	float	✓	✓	⤫	-122.419
location_area_1 The agents first-level location according to Administrative division	⤫	string	⤫	⤫	⤫	Northern
location_area_2 The agents second-level location according to Administrative division	⤫	string	⤫	⤫	⤫	Agago
location_area_3 The agents third-level location according to Administrative division	⤫	string	⤫	⤫	⤫	Arum
location_area_4 The agents fourth-level location according to Administrative division	⤫	string	⤫	⤫	⤫	Alela
location_area_5 The agents fifth-level location according to Administrative division	⤫	string	⤫	⤫	⤫	Bila
longitude_autogen Auto-generated coordinates from given location area 1-5 Only period (.) decimal delimiters are supported. Do not use commas (,) — they will cause an error.	⤫	float	⤫	⤫	✓	37.775
latitude_autogen Auto-generated coordinates from given location area 1-5 Only period (.) decimal delimiters are supported. Do not use commas (,) — they will cause an error.	⤫	float	⤫	⤫	✓	-122.419
location_area_1_autogen Auto-generated location area 1-5 from given coordinates	⤫	string	⤫	⤫	✓	Northern
location_area_2_autogen Auto-generated location area 1-5 from given coordinates	⤫	string	⤫	⤫	✓	Agago
location_area_3_autogen Auto-generated location area 1-5 from given coordinates	⤫	string	⤫	⤫	✓	Arum
location_area_4_autogen Auto-generated location area 1-5 from given coordinates	⤫	string	⤫	⤫	✓	Alela
location_area_5_autogen Auto-generated location area 1-5 from given coordinates	⤫	string	⤫	⤫	✓	Bila
created_at Timestamp when row was inserted	⤫	datetime	⤫	⤫	✓	2021-05-03 6:23:55
updated_at Timestamp when row was updated	⤫	datetime	⤫	⤫	✓	2021-05-03 6:23:55
source_id References Source of data	⤫	integer	⤫	⤫	✓	1
import_id References Import of data	⤫	integer	⤫	⤫	✓	1
organization_id References Organization of data	⤫	integer	⤫	⤫	✓	1
custom Saves additional imported data out of standard structure	⤫	jsonb	⤫	⤫	✓	{ "some": "key" }
data_origin Origin of the data, generic or name of the api	⤫	string	⤫	⤫	✓	generic
last_import_id Id of the last import which updated the record	⤫	integer	⤫	⤫	✓	337
last_source_id Id of the last Source which updated the record	⤫	integer	⤫	⤫	✓	33