List community agents
GET
/api/partners/v1/community/{community_id}/agents/
Return a list of agents associated with the community
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “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.
1234Funnel Community Syndication ID
The community’s Funnel syndcation ID. An ID in this format is often provided in Funnel feeds to ILS partners.
P1234-567Partner ID
The ID of the community in the partner system. This needs to have been previously provided to Funnel and setup.
partner-id:apts123Query Parameters
Section titled “Query Parameters ” page
integer
Page number
Responses
Section titled “ Responses ”Success
object
items
Array<object>
object
first_name
string
last_name
string
email
string
id
integer format: int32
page
integer
total_pages
integer
total_items
integer
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.A community with this ID does not exist.
object
error_type
string
CommunityNotFound message
string
Could not find community with corresponding ID.