List companies - TalkToHumans

GET

https://api.talktohumans.app

/

v1

/

companies

List companies

curl --request GET \
  --url https://api.talktohumans.app/v1/companies \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.talktohumans.app/v1/companies', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

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

func main() {

	url := "https://api.talktohumans.app/v1/companies"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

{
  "data": {
    "companies": [
      {
        "company_id": "<string>",
        "provider_participant_id": "<string>",
        "name": "<string>",
        "industries": [
          {
            "name": "<string>",
            "title": "<string>",
            "industry_urn": "<string>",
            "provider_industry_id": "<string>",
            "hierarchy": "<string>"
          }
        ],
        "locations": [
          {
            "is_primary": true,
            "is_headquarter": true,
            "linkedin_text": "<string>",
            "display_text": "<string>",
            "country_code": "<string>",
            "region_code": "<string>",
            "country": "<string>",
            "country_full": "<string>",
            "state": "<string>",
            "city": "<string>",
            "geographic_area": "<string>"
          }
        ],
        "public_identifier": "<string>",
        "headline": "<string>",
        "linkedin_url": "<string>",
        "avatar_url": "<string>",
        "background_cover_url": "<string>",
        "headcount": "<string>",
        "employee_count": 123,
        "founding_date": "<string>",
        "website_url": "<string>",
        "follower_count": 123,
        "about": "<string>",
        "notes_json": "<string>",
        "tags": [
          {
            "name": "<string>"
          }
        ]
      }
    ],
    "pagination": {
      "limit": 10,
      "has_more": true,
      "next_cursor": "<string>"
    }
  }
}

Authorizations

Authorization

string

header

required

Pass API key as Authorization: Bearer <api_key>.

Query Parameters

account_id

string[]

LinkedIn account IDs returned by GET /v1/accounts.

Repeat the query parameter for multiple accounts. The backend also accepts comma-separated values. If an explicit account target is not accessible to this credential, the API returns 403 account_shared_access_required.

Pattern: ^[1-9][0-9]*$

view_id

string

Optional. Return only companies associated with contacts in a saved TalkToHumans contact view. Accepts the view id or public_id returned by GET /v1/views. When provided, results are scoped to the view's LinkedIn account and account_id is ignored.

limit

integer

default:10

Page size. Defaults to 10. Values above 25 are clamped to 25.

Required range: 1 <= x <= 25

cursor

string

Opaque cursor from the previous response's pagination.next_cursor.

Response

Companies matching the filters.

data

object

required

Show child attributes

List companies

curl --request GET \
  --url https://api.talktohumans.app/v1/companies \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.talktohumans.app/v1/companies', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

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

func main() {

	url := "https://api.talktohumans.app/v1/companies"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

{
  "data": {
    "companies": [
      {
        "company_id": "<string>",
        "provider_participant_id": "<string>",
        "name": "<string>",
        "industries": [
          {
            "name": "<string>",
            "title": "<string>",
            "industry_urn": "<string>",
            "provider_industry_id": "<string>",
            "hierarchy": "<string>"
          }
        ],
        "locations": [
          {
            "is_primary": true,
            "is_headquarter": true,
            "linkedin_text": "<string>",
            "display_text": "<string>",
            "country_code": "<string>",
            "region_code": "<string>",
            "country": "<string>",
            "country_full": "<string>",
            "state": "<string>",
            "city": "<string>",
            "geographic_area": "<string>"
          }
        ],
        "public_identifier": "<string>",
        "headline": "<string>",
        "linkedin_url": "<string>",
        "avatar_url": "<string>",
        "background_cover_url": "<string>",
        "headcount": "<string>",
        "employee_count": 123,
        "founding_date": "<string>",
        "website_url": "<string>",
        "follower_count": 123,
        "about": "<string>",
        "notes_json": "<string>",
        "tags": [
          {
            "name": "<string>"
          }
        ]
      }
    ],
    "pagination": {
      "limit": 10,
      "has_more": true,
      "next_cursor": "<string>"
    }
  }
}