Get a list of contacts for a specific org.
curl --request GET \
--url https://api.useinvent.com/orgs/{org_id}/contacts[
{
"id": "<string>",
"name": "<string>",
"blocked": true,
"unsubscribed": true,
"is_admin": true,
"channels": [
{
"id": "<string>",
"type": "internal",
"user_id": "<string>",
"avatar": "<string>",
"name": "<string>",
"username": "<string>",
"email": "<string>",
"phone": "<string>",
"country": "<string>",
"agent": "<string>",
"ip": "<string>",
"language": "<string>",
"platform_data": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"link": "<string>"
}
],
"segments": [
{
"id": "<string>",
"name": "<string>",
"color": "red",
"contacts_count": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"blocked_at": "2023-11-07T05:31:56Z",
"unsubscribed_at": "2023-11-07T05:31:56Z",
"unsubscribe_reason": "<string>",
"unsubscribe_feedback": "<string>"
}
]The ID of the org
Search contacts by name
Whether the contact is an admin
Whether the contact is unsubscribed
Search contacts by user ID match
Search contacts by name match
Search contacts by username match
Search contacts by email match
Search contacts by segment ID match
Page number
Number of items to take
Next page token (Only used on special endpoints)
Show child attributes
Show child attributes
Was this page helpful?
curl --request GET \
--url https://api.useinvent.com/orgs/{org_id}/contacts[
{
"id": "<string>",
"name": "<string>",
"blocked": true,
"unsubscribed": true,
"is_admin": true,
"channels": [
{
"id": "<string>",
"type": "internal",
"user_id": "<string>",
"avatar": "<string>",
"name": "<string>",
"username": "<string>",
"email": "<string>",
"phone": "<string>",
"country": "<string>",
"agent": "<string>",
"ip": "<string>",
"language": "<string>",
"platform_data": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"link": "<string>"
}
],
"segments": [
{
"id": "<string>",
"name": "<string>",
"color": "red",
"contacts_count": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"blocked_at": "2023-11-07T05:31:56Z",
"unsubscribed_at": "2023-11-07T05:31:56Z",
"unsubscribe_reason": "<string>",
"unsubscribe_feedback": "<string>"
}
]