Companies

Get a company by domain

get

Required scopes

This endpoint requires the following scopes:

Authorizations

AuthorizationstringRequired

Your Goodfit API key, sent as the bare header value

Path parameters

domainstring · min: 1Required

Primary domain, without scheme or path

Query parameters

data_pointsany ofOptional

fieldNames of the data points to return, from the data points list. The identifying data points always come back. Omit for every data point; ["*"] also means every one; [] means only the identifying data points

string[] · max: 200Optional

or

string · min: 1 · max: 200Optional

Responses

200

Get a company by domain

application/json

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

No company in your dataset has this domain

application/json

429

Too many requests

application/json

500

Internal server error

application/json

get/dataset/companies/{domain}

GET /dataset/companies/{domain} HTTP/1.1
Host: api.goodfit.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "company": {
    "__company_id": "text",
    "__added_at": "text",
    "__updated_at": "text",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

List companies

get

Required scopes

This endpoint requires the following scopes:

Authorizations

AuthorizationstringRequired

Your Goodfit API key, sent as the bare header value

Query parameters

limitinteger · min: 1 · max: 1000Optional

Rows per page, 1 to 1000

Default: 100

iteratorstring · min: 1Optional

Opaque cursor from a previous response. Omit for the first page

updated_sincestring · min: 1Optional

Only rows updated on or after this date

added_sincestring · min: 1Optional

Only rows added on or after this date

segment_idstring · uuidOptional

Only companies currently in this segment

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$

data_pointsany ofOptional

fieldNames of the data points to return, from the data points list. The identifying data points always come back. Omit for every data point; ["*"] also means every one; [] means only the identifying data points

string[] · max: 200Optional

or

string · min: 1 · max: 200Optional

Responses

200

List companies

application/json

totalCompaniesinteger · max: 9007199254740991Required

nextIteratorstring · nullableRequired

Pass as iterator to fetch the next page. Null on the last page

hasMoreResultsbooleanRequired

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

No segment in your account has this segment_id

application/json

429

Too many requests

application/json

500

Internal server error

application/json

get/dataset/companies

GET /dataset/companies HTTP/1.1
Host: api.goodfit.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "companies": [
    {
      "__company_id": "text",
      "__added_at": "text",
      "__updated_at": "text",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "totalCompanies": 1,
  "nextIterator": "text",
  "hasMoreResults": true
}

List company data points

get

Required scopes

This endpoint requires the following scopes:

Authorizations

AuthorizationstringRequired

Your Goodfit API key, sent as the bare header value

Responses

200

List company data points

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

429

Too many requests

application/json

500

Internal server error

application/json

get/dataset/companies/fields

GET /dataset/companies/fields HTTP/1.1
Host: api.goodfit.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "fields": [
    {
      "fieldName": "text",
      "displayName": "text",
      "fieldType": "String",
      "operators": [
        "exists"
      ],
      "description": "text",
      "isIntel": true
    }
  ]
}

Search companies

post

Required scopes

This endpoint requires the following scopes:

Authorizations

AuthorizationstringRequired

Your Goodfit API key, sent as the bare header value

Body

filtersanyRequired

Filter group over the data points listed by GET /companies/fields

Example: {"id":"root","combinator":"and","rules":[{"id":"r1","field":"__match_sourcing_criteria","operator":"booleanTrue"}]}

limitinteger · min: 1 · max: 1000OptionalDefault: 100

iteratorstringOptional

data_pointsany ofOptional

fieldNames of the data points to return, from the data points list. The identifying data points always come back. Omit for every data point; ["*"] also means every one; [] means only the identifying data points

string[] · max: 200Optional

or

string · min: 1 · max: 200Optional

Responses

200

Search companies

application/json

totalCompaniesinteger · max: 9007199254740991Required

nextIteratorstring · nullableRequired

hasMoreResultsbooleanRequired

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

429

Too many requests

application/json

500

Internal server error

application/json

post/dataset/companies/search

POST /dataset/companies/search HTTP/1.1
Host: api.goodfit.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 180

{
  "filters": {
    "id": "root",
    "combinator": "and",
    "rules": [
      {
        "id": "r1",
        "field": "__match_sourcing_criteria",
        "operator": "booleanTrue"
      }
    ]
  },
  "limit": 100,
  "iterator": "text",
  "data_points": [
    "text"
  ]
}

{
  "companies": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "totalCompanies": 1,
  "nextIterator": "text",
  "hasMoreResults": true
}