Fetch your team information
Retrieve the team associated with your API token.
GET
https://api.thecompaniesapi.com/v2/team/:teamId
Free
If you want to get information about your team, like the number of credits you have, you can use this feature.
Signup to access all our API features
Get your 500 free credits and start enriching and searching companies.
No credit card required
Response schema
countrystring
The team's country.
us
createdAtdate
The team's creation date.
2020-06-29 08:21:01
creditsnumber
The team's credits.
500000
isSubscriberboolean
If the team is subscribed to a paid plan.
true
idnumber
The team's id.
1
namestring
The team's name.
Jay Gatsby Enterprises
websiteUrlstring
The team's website url.
https://www.jaygatsbyenterprises.com
API response
{country : "us" ,createdAt : "2020-06-29 08:21:01" ,credits :500000,id :1,isSubscriber :true,name : "Jay Gatsby Enterprises" ,websiteUrl : "https://www.jaygatsbyenterprises.com" ,}
Code examples
Select your favorite language:
import createClient from '@thecompaniesapi/sdk'
const tca = createClient({ apiToken: 'YOUR_API_TOKEN' })
const response = await tca.fetchTeam()
const team = response.data // Your team details