Retrieve Facility List

Gets a list of Facilities associated to your api key.

SecurityApiKeyAuth and CustomAuth

Request

path Parameters

state

required

string

Lower case ANSI standard 38:2009 USPS codes of the US state where licensee is operating.

Enum: "ca" "il" "wa" "ma" "md" "mi" "wv" "co" "ok" "oh"

query Parameters

entity_state

string

Queryable entity states for Facility.

Enum: "active" "inactive" "deleted"

header Parameters

x-api-key required	string Trace API key header Example: b123x21wbHlkYXBpa2V5
Authorization required	string Company and user credentials authentication Example: KMP-JSON token=dmVuZG9yLWFwaS1rZXk6dX12312sdfs2V5

Responses

200

400

Bad Request

get/{state}/v1/config/facilities

Response samples

application/json

{"results": {"type": "array",
"data": [{"id": "e1967c3bf9c84d7f828815f4814f5116",
"reference_id": "000000000123",
"name": null,
"display_name": null,
"identifier_code": "0000000000123",
"phone_number": "123-432-1234",
"timezone": "America/New_York",
"licenses": [{"license_number": "040-X0002"
}
],
"address": {"address_line_1": "123 farmlab st.",
"address_line_2": "Suite 100",
"address_line_3": null,
"country": "USA",
"county": "Cleveland",
"city": "Cleveland",
"state": "OH",
"zip": "54321",
"gps": null
},
"entity_state": [{"state": "active",
"date": "2024-01-05T15:27:39Z",
"reason": "facility created",
"actioned_by": "system_generated"
},
{"state": "updated",
"date": "2024-01-05T15:27:39Z",
"reason": "facility updated",
"actioned_by": "system_generated"
}
]
}
]
},
"warnings": [ ]
}