Skip to main content
GET
/
providers
List all available providers
curl --request GET \
  --url https://api.sandbox.goteal.co/providers \
  --header 'X-API-KEY: <api-key>'
{
  "providers": [
    {
      "id": "dayforce",
      "name": "Dayforce",
      "url": "https://www.dayforcehcm.com/mydayforce/login.aspx",
      "logo_url": "https://logourl.com/dayforce.png",
      "is_oauth2": false,
      "is_scraper": true,
      "reset_url": "https://costa.dayforcehcm.com/",
      "parent": null,
      "max_login_attempts": 3,
      "extra_login_params": [
        {
          "key": "company_name",
          "display_name": "Company Name",
          "validation": {
            "required": true,
            "type": "Text, Date, Number",
            "date_format": "dd/MM/yyyy",
            "min_length": 3,
            "max_length": 10
          }
        }
      ]
    }
  ],
  "parent_provider_meta": [
    {
      "id": "adp-parent",
      "name": "ADP",
      "logo_url": "https://logo.net/logos/adp.png"
    }
  ],
  "employers": [
    {
      "id": "teal",
      "name": "Teal",
      "url": "",
      "logo_url": "https://d1wfx42f6qh83.cloudfront.net/logos/teal_0d28113814a9.png",
      "providers": [
        "shape"
      ]
    }
  ]
}

Authorizations

X-API-KEY
string
header
required

Response

OK

providers
object[]
required

List of available payroll providers

parent_provider_meta
object[]
required

List of parent provider metadata

employers
object[]
required

List of employers and their associated providers