Get vendor by ID | Propexo

curl https://api.propexo.com/v1/vendors/vendor_id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json"

{
  "meta": {
    "orderBy": [
      {}
    ],
    "offset": 0,
    "limit": 100,
    "hasMore": true,
    "total": 1000
  },
  "results": {
    "id": "clwktsp9v000008l31iv218hn",
    "created_at": "2024-03-21T15:38:08.337Z",
    "updated_at": "2024-03-22T10:59:45.119Z",
    "last_seen": "2024-03-22T10:59:45.119Z",
    "x_id": "vendor-78945",
    "x_property_id": "property-45612",
    "x_location_id": null,
    "account_number": null,
    "is_active": true,
    "name": "Greenfield Maintenance Services",
    "notes": "Preferred vendor for landscaping and general maintenance.",
    "tax_id": null,
    "third_party_id": null,
    "type": null,
    "contacts": [
      {
        "address_1": "123 Main St",
        "address_2": "Suite 400",
        "city": "Boston",
        "country": "US",
        "state": "MA",
        "zip": "02116",
        "phone": "+1-617-555-0199",
        "phone_type": "office",
        "email": "contact@greenfieldservices.com",
        "is_primary": true,
        "name": "John Doe"
      }
    ],
    "custom_data": {},
    "integration_id": "clwh5u07w000508me66sfh3um",
    "integration_vendor": "YARDI",
    "property_id": "clwi5xiix000008l6ctdgafyh"
  }
}

curl https://api.propexo.com/v1/vendors/vendor_id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json"

{
  "meta": {
    "orderBy": [
      {}
    ],
    "offset": 0,
    "limit": 100,
    "hasMore": true,
    "total": 1000
  },
  "results": {
    "id": "clwktsp9v000008l31iv218hn",
    "created_at": "2024-03-21T15:38:08.337Z",
    "updated_at": "2024-03-22T10:59:45.119Z",
    "last_seen": "2024-03-22T10:59:45.119Z",
    "x_id": "vendor-78945",
    "x_property_id": "property-45612",
    "x_location_id": null,
    "account_number": null,
    "is_active": true,
    "name": "Greenfield Maintenance Services",
    "notes": "Preferred vendor for landscaping and general maintenance.",
    "tax_id": null,
    "third_party_id": null,
    "type": null,
    "contacts": [
      {
        "address_1": "123 Main St",
        "address_2": "Suite 400",
        "city": "Boston",
        "country": "US",
        "state": "MA",
        "zip": "02116",
        "phone": "+1-617-555-0199",
        "phone_type": "office",
        "email": "contact@greenfieldservices.com",
        "is_primary": true,
        "name": "John Doe"
      }
    ],
    "custom_data": {},
    "integration_id": "clwh5u07w000508me66sfh3um",
    "integration_vendor": "YARDI",
    "property_id": "clwi5xiix000008l6ctdgafyh"
  }
}

Get vendor by ID

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

vendor_idstringRequired

The ID of the resource.

Query parameters

order-bystringOptionalDefaults to created_at:desc

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

offsetinteger or nullOptional>=0Defaults to 0

Can be used for paginating results

limitinteger or nullOptional0-250Defaults to 100

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

Response

Successful response

metaobject

resultsobject

Errors

400

Bad Request Error

$	curl https://api.propexo.com/v1/vendors/vendor_id \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json"

1	{
2	"meta": {
3	"orderBy": [
4	{}
5	],
6	"offset": 0,
7	"limit": 100,
8	"hasMore": true,
9	"total": 1000
10	},
11	"results": {
12	"id": "clwktsp9v000008l31iv218hn",
13	"created_at": "2024-03-21T15:38:08.337Z",
14	"updated_at": "2024-03-22T10:59:45.119Z",
15	"last_seen": "2024-03-22T10:59:45.119Z",
16	"x_id": "vendor-78945",
17	"x_property_id": "property-45612",
18	"x_location_id": null,
19	"account_number": null,
20	"is_active": true,
21	"name": "Greenfield Maintenance Services",
22	"notes": "Preferred vendor for landscaping and general maintenance.",
23	"tax_id": null,
24	"third_party_id": null,
25	"type": null,
26	"contacts": [
27	{
28	"address_1": "123 Main St",
29	"address_2": "Suite 400",
30	"city": "Boston",
31	"country": "US",
32	"state": "MA",
33	"zip": "02116",
34	"phone": "+1-617-555-0199",
35	"phone_type": "office",
36	"email": "contact@greenfieldservices.com",
37	"is_primary": true,
38	"name": "John Doe"
39	}
40	],
41	"custom_data": {},
42	"integration_id": "clwh5u07w000508me66sfh3um",
43	"integration_vendor": "YARDI",
44	"property_id": "clwi5xiix000008l6ctdgafyh"
45	}
46	}