Get an event by ID

GET

/v1/events/:event_id

Get an event by ID

Path parameters

event_idstringRequired

The ID of the resource.

Query parameters

order-bystringOptional

Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc

offsetintegerOptional

Can be used for paginating results

limitintegerOptional

A number between 1 and 250 to determine the number of results to return in a single query

Response

This endpoint returns an object.

metaobject

resultsobject

Errors

GET

1 curl https://api.propexo.com/v1/events/event_id \
2      -H "Authorization: Bearer <token>"

1 {
2   "meta": {
3     "orderBy": [
4       {}
5     ],
6     "offset": 42,
7     "limit": 42,
8     "hasMore": true,
9     "total": 42
10   },
11   "results": {
12     "id": "sample_value",
13     "created_at": "2024-07-01T00:00:00.000Z",
14     "updated_at": "2024-07-01T00:00:00.000Z",
15     "x_id": "sample_value",
16     "x_property_id": "sample_value",
17     "integration_id": "sample_value",
18     "integration_vendor": "sample_value",
19     "property_id": "sample_value",
20     "last_seen": "2024-07-01T00:00:00.000Z",
21     "x_leasing_agent_id": "sample_value",
22     "x_type_id": "sample_value",
23     "x_location_id": "sample_value",
24     "event_name": "sample_value",
25     "event_datetime": "2024-07-01T00:00:00.000Z",
26     "appointment_datetime": "2024-07-01T00:00:00.000Z",
27     "type_raw": "sample_value",
28     "notes": "sample_value",
29     "agent_name": "sample_value",
30     "reasons_for_event": "sample_value",
31     "associated_lead_ids": [
32       "sample_value"
33     ],
34     "associated_applicant_ids": [
35       "sample_value"
36     ],
37     "associated_resident_ids": [
38       "sample_value"
39     ]
40   }
41 }

Built with

1	curl https://api.propexo.com/v1/events/event_id \
2	-H "Authorization: Bearer <token>"

1	{
2	"meta": {
3	"orderBy": [
4	{}
5	],
6	"offset": 42,
7	"limit": 42,
8	"hasMore": true,
9	"total": 42
10	},
11	"results": {
12	"id": "sample_value",
13	"created_at": "2024-07-01T00:00:00.000Z",
14	"updated_at": "2024-07-01T00:00:00.000Z",
15	"x_id": "sample_value",
16	"x_property_id": "sample_value",
17	"integration_id": "sample_value",
18	"integration_vendor": "sample_value",
19	"property_id": "sample_value",
20	"last_seen": "2024-07-01T00:00:00.000Z",
21	"x_leasing_agent_id": "sample_value",
22	"x_type_id": "sample_value",
23	"x_location_id": "sample_value",
24	"event_name": "sample_value",
25	"event_datetime": "2024-07-01T00:00:00.000Z",
26	"appointment_datetime": "2024-07-01T00:00:00.000Z",
27	"type_raw": "sample_value",
28	"notes": "sample_value",
29	"agent_name": "sample_value",
30	"reasons_for_event": "sample_value",
31	"associated_lead_ids": [
32	"sample_value"
33	],
34	"associated_applicant_ids": [
35	"sample_value"
36	],
37	"associated_resident_ids": [
38	"sample_value"
39	]
40	}
41	}