Contacts

List contact 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 contact 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/contacts/fields

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

{
  "fields": [
    {
      "fieldName": "text",
      "displayName": "text",
      "fieldType": "String",
      "description": "text"
    }
  ]
}

List contacts

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

company_idstring · min: 1Optional

Restrict to contacts at one company

company_domainstring · min: 1Optional

Restrict to contacts at the company with this domain

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 contacts

application/json

totalContactsinteger · 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

429

Too many requests

application/json

500

Internal server error

application/json

get/dataset/contacts

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

{
  "contacts": [
    {
      "__id": "text",
      "__company_id": "text",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "totalContacts": 1,
  "nextIterator": "text",
  "hasMoreResults": true
}