Get unit details

GET

/api/partners/v1/community/{community_id}/unit-by-xid/{unit_xid}/

Return a unit details from an unit_xid and community_id

Authorizations

• BasicAuth
• BearerAuth

Parameters

Path Parameters

community_id

required

string

The Community ID, this will look like either ‘1234’ or ‘P1234-567’. Alternatively, if you prefix this value with partner-id:, for example partner-id:apts123 you can use your own community, as long as you have previously provided that ID to Funnel.

Examples

Funnel Community ID

The raw integer Funnel ID of a community.

1234

Funnel Community Syndication ID

The community’s Funnel syndcation ID. An ID in this format is often provided in Funnel feeds to ILS partners.

P1234-567

Partner ID

The ID of the community in the partner system. This needs to have been previously provided to Funnel and setup.

partner-id:apts123

unit_xid

required

string

The external id for the unit.

Example

123

Responses

200

Success

object

community_id

The id of the community

integer

123

building_id

The id of the building

integer

123

unit_id

The id of the unit

integer

123

unit_xid

The unit_xid

string

123

400

401

403

We were unable to authenticate your request with the provided API key.

object

error_type

string

CommunityNotFound

message

string

Could not find community with corresponding ID.

404

The unit does not exist.

object

error_type

string

UnitNotFound

message

string

Unit not found.