Podio API Documentation
Contacts: Get organization contacts
Returns all the profiles of the users contacts on the given organization. For the details of the possible return values, see the area.
- PHP Client
-
PodioContact.php
PodioContact::get_for_org( $org_id, $attributes = array() ); - Ruby Gem
-
profile.rb
Podio::Profile.find_all_for_org( org_id, options = {} )
- org_id*
- Required.
- {field}
A value for the required field. For text fields partial matches will be returned.
- contact_type
The types of contacts to return, can be either "user" or "space". Separate by comma to get multiple types, or leave blank for all contacts.
Default value: user- exclude_self
True to exclude self, False to include self.
Default value: true- limit
The maximum number of contacts that should be returned
- offset
The offset to use when returning contacts
- order
The order in which the contacts can be returned. See the area for details on the ordering options.
Default value: name- required
A comma-separated list of fields that should exist for the contacts returned. Useful for only getting contacts with an email address or phone number.
- type
Determines the way the result is returned. Valid options are "mini" and "full".
Default value: mini
[
{
"profile_id": The id of the profile,
"type": The type of contact, either "user" or "space",
"{field}": The value of the field,
... (more fields, see the contact area)
},
... (more contacts)
]
Sandbox
Try the operation "/contact/org/{org_id}"You can simulate the API request by filling out the arguments below, and press the submit button to see the response.
You need to be logged in to Podio to use the Sandbox. Login here