Partner API
CSV Template Field Reference
Column definitions for the file uploaded with the Partner CSV Upload API.
Field overview
| Field name | Description | Requirement |
|---|---|---|
practice_name | Name of the practice or organization, for example Rindler Periodontics or Specialized Aspen Dental. | Required for all implementations |
practice_email | Practice owner's email address. This email is used to create the Intelibly account and provide dashboard access. | Required for all implementations |
practice_website | Practice website URL. | Optional |
practice_contact_name | Full name of the practice owner. | Required for all implementations |
location_name | Name of a location when used with dental organizations, for example Aspen Dental of Arlington. | Optional |
location_phone | Phone number of the location. | Required for all implementations |
location_street | Street address of the location, including suite information when applicable. | Required for all implementations |
location_city | City of the location. | Required for all implementations |
location_state | State of the location. | Required for all implementations |
location_zip | ZIP code of the location. | Required for all implementations |
location_internal_id | GUID of the location used by the partner. This must be a globally unique identifier used to identify the location. It must also be present on the provider finder page where the location/provider result is displayed. | Required for FinderCONNECT Button |
provider_name | Name of the provider working at the current location. | Required for all implementations |
provider_specialty | Specialty name of the provider, for example General Dentist or Periodontist. The system attempts to match the specialty by name. If no match is found, the provider will be assigned the General Dentist specialty. | Required for all implementations |
provider_internal_id | GUID of the provider used by the partner. This must be a globally unique identifier used to identify the provider. It must also be present on the provider finder page where the location/provider result is displayed. | Required for FinderCONNECT Button |
provider_location_internal_id | Partner directory-point ID representing the provider-location pairing. | Required if location_internal_id and provider_internal_id are not available |
partner_tier_name | Name of a tier assigned to a provider. Tiers allow ranking providers and can be used to sort provider search results. | Optional, FinderCONNECT Map only |
practice_internal_id | GUID of the practice or organization used by the partner. This should be a globally unique identifier used to identify the practice. | Optional |
npi_number | National Provider Identification number assigned to an individual provider. | Optional |
partner_tags | Name of a tag assigned to a location. Tags allow logical grouping and categorization of location results. | Optional, FinderCONNECT Map only |
Implementation notes
- Fields marked Required for all implementations should be populated for every record in the CSV.
- Internal ID fields should be stable, globally unique values supplied by the partner.
- For FinderCONNECT Button implementations, both location and provider internal IDs are required. If location and provider internal IDs are not available, the provider location internal ID is required.
- For FinderCONNECT Map use cases, tier and tag fields can be used to improve result ranking and categorization.
- Provider specialty values should be written clearly using standard specialty names to improve matching accuracy.
Supported provider specialties
- Endodontist
- General Dentist
- Oral Surgeon
- Orthodontist
- Other
- Pediatric Dentist
- Periodontist
- Prosthodontist
Last modified on