Skip to main content
GET
/
orgs
/
{org_id}
/
contacts
Get Contacts
curl --request GET \
  --url https://api.useinvent.com/orgs/{org_id}/contacts
[
  {
    "id": "<string>",
    "name": "<string>",
    "blocked": 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>",
        "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"
  }
]

Path Parameters

​
org_id
string
required

The ID of the org

Query Parameters

​
search
string

Search contacts by name

​
is_admin
boolean

Whether the contact is an admin

​
user_id
string

Search contacts by user ID match

​
name
string

Search contacts by name match

​
username
string

Search contacts by username match

​
email
string<email>

Search contacts by email match

​
segment_id
string

Search contacts by segment ID match

​
page
number

Page number

​
take
number

Number of items to take

​
next
string

Next page token (Only used on special endpoints)

Response

200 - application/json
​
id
string
required
​
name
string | null
required
​
blocked
boolean
required
​
is_admin
boolean
required
​
channels
object[]
required
​
segments
object[]
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required