Find a contact by channel identifier

Resolves a channel-side identifier — a phone number, an Apple Messages id, a widget session id — to the Tied contact behind it, with all of that contact’s channel identities expanded.

This is the lookup to use when an external system knows someone by their phone number or provider id and needs the Tied contact. Returns 404 when nothing in that inbox matches, so a 404 means “not seen on this channel” rather than “no such contact”.

POST

api

accounts

{account_id}

contact_inboxes

filter

Find a contact by channel identifier

curl --request POST \
  --url https://app.tied.com/api/v1/accounts/{account_id}/contact_inboxes/filter \
  --header 'Content-Type: application/json' \
  --header 'api_access_token: <api-key>' \
  --data '
{
  "inbox_id": 1,
  "source_id": "EXAMPLE_SOURCE_ID"
}
'

import requests

url = "https://app.tied.com/api/v1/accounts/{account_id}/contact_inboxes/filter"

payload = {
    "inbox_id": 1,
    "source_id": "EXAMPLE_SOURCE_ID"
}
headers = {
    "api_access_token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({inbox_id: 1, source_id: 'EXAMPLE_SOURCE_ID'})
};

fetch('https://app.tied.com/api/v1/accounts/{account_id}/contact_inboxes/filter', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

require 'uri'
require 'net/http'

url = URI("https://app.tied.com/api/v1/accounts/{account_id}/contact_inboxes/filter")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["api_access_token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"inbox_id\": 1,\n  \"source_id\": \"EXAMPLE_SOURCE_ID\"\n}"

response = http.request(request)
puts response.read_body

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.tied.com/api/v1/accounts/{account_id}/contact_inboxes/filter"

	payload := strings.NewReader("{\n  \"inbox_id\": 1,\n  \"source_id\": \"EXAMPLE_SOURCE_ID\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("api_access_token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "additional_attributes": {},
  "availability_status": "offline",
  "email": null,
  "id": 231,
  "name": "Jordan Mitchell",
  "phone_number": null,
  "blocked": false,
  "identifier": null,
  "thumbnail": "",
  "thumbnail_background_color": null,
  "domain_logo_avatar": false,
  "customer_verified": false,
  "custom_attributes": {},
  "created_at": 1789963450,
  "contact_inboxes": [
    {
      "source_id": "EXAMPLE_SOURCE_ID",
      "inbox": {
        "id": 1,
        "avatar_url": "https://app.tied.com/rails/active_storage/blobs/proxy/EXAMPLE/tied-app-icon.png",
        "channel_id": 1,
        "name": "Apple Messages",
        "channel_type": "Channel::Amb",
        "provider": null
      }
    }
  ]
}

{
  "error": "Resource could not be found"
}

{
  "error": "Resource could not be found"
}

Authorizations

api_access_token

string

header

required

This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.

Path Parameters

integer

required

The numeric ID of the account

Body

application/json

inbox_id

integer

required

The inbox to look in.

Example:

1

source_id

integer

required

The channel-side identifier to resolve — a phone number, an Apple Messages id, a widget session id.

Example:

"amb:demo-0"

Response

Success

payload

object[]

List of contacts

Show child attributes

Find a contact by channel identifier

curl --request POST \
  --url https://app.tied.com/api/v1/accounts/{account_id}/contact_inboxes/filter \
  --header 'Content-Type: application/json' \
  --header 'api_access_token: <api-key>' \
  --data '
{
  "inbox_id": 1,
  "source_id": "EXAMPLE_SOURCE_ID"
}
'

import requests

url = "https://app.tied.com/api/v1/accounts/{account_id}/contact_inboxes/filter"

payload = {
    "inbox_id": 1,
    "source_id": "EXAMPLE_SOURCE_ID"
}
headers = {
    "api_access_token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({inbox_id: 1, source_id: 'EXAMPLE_SOURCE_ID'})
};

fetch('https://app.tied.com/api/v1/accounts/{account_id}/contact_inboxes/filter', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

require 'uri'
require 'net/http'

url = URI("https://app.tied.com/api/v1/accounts/{account_id}/contact_inboxes/filter")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["api_access_token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"inbox_id\": 1,\n  \"source_id\": \"EXAMPLE_SOURCE_ID\"\n}"

response = http.request(request)
puts response.read_body

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.tied.com/api/v1/accounts/{account_id}/contact_inboxes/filter"

	payload := strings.NewReader("{\n  \"inbox_id\": 1,\n  \"source_id\": \"EXAMPLE_SOURCE_ID\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("api_access_token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "additional_attributes": {},
  "availability_status": "offline",
  "email": null,
  "id": 231,
  "name": "Jordan Mitchell",
  "phone_number": null,
  "blocked": false,
  "identifier": null,
  "thumbnail": "",
  "thumbnail_background_color": null,
  "domain_logo_avatar": false,
  "customer_verified": false,
  "custom_attributes": {},
  "created_at": 1789963450,
  "contact_inboxes": [
    {
      "source_id": "EXAMPLE_SOURCE_ID",
      "inbox": {
        "id": 1,
        "avatar_url": "https://app.tied.com/rails/active_storage/blobs/proxy/EXAMPLE/tied-app-icon.png",
        "channel_id": 1,
        "name": "Apple Messages",
        "channel_type": "Channel::Amb",
        "provider": null
      }
    }
  ]
}

{
  "error": "Resource could not be found"
}

{
  "error": "Resource could not be found"
}

Getting started

Conversations

Contacts

Inboxes and channels

Automation and routing

Reporting

Help Center

Account and access

Billing

Client API

Widget API

Receiving webhooks

Find a contact by channel identifier

Authorizations

Path Parameters

Body

Response