Get all applications

GET

/v1/applications/

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

x_idstringOptional

The external applicant id

location_idstringOptional

The Propexo unique identifier for the location associated with the property. This is the location specified in RentManager

property_idstringOptional

The Propexo property id

integration_idstringOptional

The Propexo integration id

integration_vendorenumOptional

The integration vendor for the applicant.

Response

This endpoint returns an object.

metaobject

resultslist of objects

Errors

GET

1 curl https://api.propexo.com/v1/applications/ \
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     {
13       "id": "sample_value",
14       "created_at": "2024-07-01T00:00:00.000Z",
15       "updated_at": "2024-07-01T00:00:00.000Z",
16       "x_id": "12",
17       "x_property_id": "sample_value",
18       "status": "APPROVED",
19       "applicants": [
20         {
21           "applicant_id": "sample_value",
22           "application_id": "sample_value",
23           "status_raw": "sample_value",
24           "status_normalized": "sample_value",
25           "status": "APPROVED"
26         }
27       ],
28       "integration_id": "sample_value",
29       "integration_vendor": "sample_value",
30       "property_id": "sample_value",
31       "last_seen": "2024-07-01T00:00:00.000Z",
32       "x_location_id": "sample_value",
33       "x_unit_id": "null"
34     }
35   ]
36 }

Create Application

Up Next

Built with

1	curl https://api.propexo.com/v1/applications/ \
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	{
13	"id": "sample_value",
14	"created_at": "2024-07-01T00:00:00.000Z",
15	"updated_at": "2024-07-01T00:00:00.000Z",
16	"x_id": "12",
17	"x_property_id": "sample_value",
18	"status": "APPROVED",
19	"applicants": [
20	{
21	"applicant_id": "sample_value",
22	"application_id": "sample_value",
23	"status_raw": "sample_value",
24	"status_normalized": "sample_value",
25	"status": "APPROVED"
26	}
27	],
28	"integration_id": "sample_value",
29	"integration_vendor": "sample_value",
30	"property_id": "sample_value",
31	"last_seen": "2024-07-01T00:00:00.000Z",
32	"x_location_id": "sample_value",
33	"x_unit_id": "null"
34	}
35	]
36	}