TNID
  • Welcome
  • Getting Started
    • Company Authentication
    • User Authentication
    • Accessing via Postman / GraphQL Schema examples
  • Company
    • Search Companies
    • Invite Company
    • List Organization Types
    • List Vertical Types
    • Update Company Profile
    • B2B Features
      • Send B2B Connection Request
      • List B2B Connections
      • List Pending B2B Connection Requests
      • Cancel B2B Connection Request
      • Get Received B2B Connection Requests
      • Respond to B2B Connection Requests
    • B2C Features
      • List B2C (People) Connections
      • List Pending People Connection Requests
      • List Active Subscribers
      • List Pending Subscription Requests
      • Send Person (B2C) Connection Request
      • Invite People (as Company)
      • Send Person (B2C) Subscription Request
      • Cancel Pending B2C Connection Request
      • Cancel Pending B2C Subscription Request
      • Get Pending Connection Requests (People)
      • Respond to C2B Connection Request
      • Get Connected People
      • Search People
      • List Opt-Out Requests
      • Create Opt-out Request
  • User
    • Update User profile
    • Search User (People)
    • Invite User (People)
    • Connections
      • Send C2B Connection Request
      • List B2C connections
      • List received pending B2C Connection Requests
      • Respond to received B2C Connection Request
      • Revoke sent C2B Connection Request
      • List sent pending C2B Connection Requests
    • Spam Reporting Features
      • Create Spam Report
      • List Spam Reports
    • Company Features
      • Search Companies
      • Create company profile
      • List Pending C2C Connection Requests
      • Revoke sent C2C Connection Request
      • List Received C2C Connection Requests
      • Send C2C Connection Request
      • Respond C2C Connection Request
      • List C2C Connections
  • Group Features
    • Search Groups
    • List User's Groups
    • Create Group
    • Update group
    • Invite User to Group
    • Respond to Group invite
    • List pending Group invites (Sent)
    • List pending Group invites (Received)
    • Revoke Pending Group User Member Invite
    • Send Group user member join request
    • List Received Pending Group user member join request
    • List Pending Group user member join request
    • Revoke Group user member join request
    • Respond to Group user member join request
Powered by GitBook
On this page

Was this helpful?

  1. Company

Search Companies

Search for one or more companies based on name, tax ID, website, or other fields.

The company GraphQL API is accessible at /company

This endpoint will return a list of companies matching the query and in case queried props are visible to the querier, it will be possible to query by:

  • Legal name (with name field)

  • Brand name (with name field)

  • Profile name (with name field)

  • TaxID

  • Telephone number

  • Email

  • Webpage (social media or other)

Each result will return a list of companies. It is possible to pass a combination of queryable props.

query (
	$name: String
	$taxId: String
	$email: String
	$telephoneNumber: String
	$webpage: String
	$limit: Int
  ) {
	companies (
  	name: $name
  	taxId: $taxId
  	email: $email
  	telephoneNumber: $telephoneNumber
  	webpage: $webpage
  	limit: $limit
	) {
  	id
  	legalName
  	brandName
  	profileName
  	taxId
	}
  }

Example Code

import aiohttp
from gql import gql, Client
from gql.transport.aiohttp import AIOHTTPTransport

# Please note that this basic example won't work if you have an asyncio event loop running.
# In some python environments (as with Jupyter which uses IPython) an asyncio event loop is created for you.
# In that case you should use instead https://gql.readthedocs.io/en/latest/async/async_usage.html#async-usage
def search_companies(bearer_token, query_name = None, tax_id = None, email = None, phone_number = None, webpage = None, limit_count = 10):
    transport = AIOHTTPTransport(
        url="https://api.staging.v2.tnid.com/company",
        headers=
        {
            "Authorization": f"Bearer {bearer_token}"
        }
    )

    # Create a GraphQL client using the defined transport
    client = Client(transport=transport, fetch_schema_from_transport=True)

    query = gql(
        """
        query (
            $name: String
            $taxId: String
            $email: String
            $telephoneNumber: String
            $webpage: String
            $limit: Int
          ) {
            companies (
            name: $name
            taxId: $taxId
            email: $email
            telephoneNumber: $telephoneNumber
            webpage: $webpage
            limit: $limit
            ) {
            id
            legalName
            brandName
            profileName
            taxId
            }
          }
        """
    )

    params = { "name": query_name, "taxId": tax_id, "email": email, "telephoneNumber": phone_number, "webpage": webpage, "limit": limit_count }

    try:
        # Execute the query on the transport
        response = client.execute(query, params)
        print(f"Response OK when searching companies: {response}")
        return response
    except Exception as e:
        print(f"Exception when searching companies: {e}")


# Example usage:
token = "your_company_token"
search_companies(token, "ACME")

PreviousAccessing via Postman / GraphQL Schema examplesNextInvite Company

Last updated 7 months ago

Was this helpful?