All REST Endpoints
Admin Settings
- Get default admin settings
- Method: getPath:
/api/{version}/admin/defaults
- Modify admin settings
- Method: putPath:
/api/{version}/admin/defaults
- Restore default admin settings
- Method: deletePath:
/api/{version}/admin/defaults
Authentication
- Request the access token
- Method: postPath:
/api/v4/oauth2/token
Mapping
- Create/update mapping
- Method: putPath:
/api/{version}/mapping
- Delete custom maps for map IDs
- Method: deletePath:
/api/{version}/mapping
- Get a list of seeded and custom mappings
- Method: getPath:
/api/{version}/mapping/list
- Get default settings for maptype, objecttype and mapMode
- Method: getPath:
/api/{version}/mapping/default
- Get details for map ID
- Method: getPath:
/api/{version}/mapping/{mapId}
- Return attributes for a source
- Method: getPath:
/api/{version}/mapping/attributes/{source}
Match and Export
- Get log file for match job
- Method: getPath:
/api/v4/match/enrich/logfile
- Match records
- Method: postPath:
/api/v4/match/enrich
Search and Export
- Export companies/contacts based on search
- Method: postPath:
/api/v4/export
- Get advanced search attributes
- Method: getPath:
/api/v4/search/attributes/{objectType}
- Get company hierarchy tree
- Method: getPath:
/api/v4/search/companies/hierarchy/{id}
- Get details for a company or contact
- Method: getPath:
/api/v4/{objectType}/retrieve
- Get export file for a job
- Method: getPath:
/api/v4/export/results/{jobinstanceid}
- Get export file for a job as stream
- Method: getPath:
/api/v4/export/results/file/{jobinstanceid}
- Get list of companies/contacts that match criteria
- Method: postPath:
/api/v4/search
- Get log file for export job
- Method: getPath:
/api/v4/export/logs/{jobinstanceid}
- Get text-based search for companies
- Method: getPath:
/token/api/v4/company/find
- Prepare to do a find/search operation on companies
- Method: getPath:
/api/v4/company/preparefind
Sync and Export
- Exclude from sync data
- Method: postPath:
/api/v4/admin/sync/delete
- Get log file for sync job
- Method: getPath:
/api/v4/admin/sync/logfile
- Sync records
- Method: getPath:
/api/v4/admin/sync
View Export Jobs
- Get details of a job
- Method: getPath:
/api/v4/jobresource/jobinstance/{jobinstanceid}
- Get jobs that match criteria
- Method: getPath:
/api/v4/jobresource/jobinstances
View Version Information
- Get API version numbers
- Method: getPath:
/api/v4/version