{"info":{"_postman_id":"760aa27b-409f-471d-aa36-9203b9e9f736","name":"Breadcrumbs Public API - Data collector","description":"

Variables Reference

\n

The collection relies on the following variables:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
VariableDescription
endpointThe base URL for all requests. https://api.breadcrumbs.io/collector for production.
access_tokenYour personal access token.
\n

Bearer Access Token

\n

The acces token can be obtained through https://app.breadcrumbs.io/ by connecting the platform called BcCollector to your workspace. For more information contact support at dev@breadcrumbs.io

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"15277707","collectionId":"760aa27b-409f-471d-aa36-9203b9e9f736","publishedId":"UV5aevDp","public":true,"customColor":{"top-bar":"ffe700","right-sidebar":"303030","highlight":"b54cfe"},"publishDate":"2021-10-22T10:08:54.000Z"},"item":[{"name":"Contacts","item":[{"name":"Create Contact","id":"ee414150-565e-4a87-8e47-80c2ca61f550","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"contactId\": \"1\",\n \"email\": \"demo@breadcrumbs.io\",\n \"firstName\": \"Demo\",\n \"lastName\": \"User\",\n \"age\": 35,\n \"avatar\": \"http://example.com/avatar\",\n \"birthday\": \"1986-10-20T00:00:00+00:00\",\n \"description\": \"Example Description\",\n \"gender\": \"Male\",\n \"ipAddress\": \"87.218.106.169\",\n \"userAgent\": \"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.106 Safari/537.36 OPR/38.0.2220.41\",\n \"phone\": \"3334445556\",\n \"title\": \"Mr\",\n \"username\": \"Example Username\",\n \"website\": \"http://example.com\",\n \"company\":{\n \"name\": \"Example Company name\",\n \"id\": \"5345-2345-385\",\n \"industry\": \"Example Industry\",\n \"employeeCount\": 20,\n \"domain\": \"example.com\"\n },\n \"address\": {\n \"city\": \"Example City\",\n \"country\": \"Example Country\",\n \"postalCode\": \"180210\",\n \"state\": \"Example State\",\n \"street\": \"Example Street\"\n },\n \"properties\": {\n \"test_extra_2\": \"string\",\n \"test_extra_3\": [\n \"nested\"\n ]\n },\n \"createdAt\": \"2021-11-09T15:00:47+00:00\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.breadcrumbs.io/collector/contacts","description":"

Create a contact.

\n

Query Params

\n

Optional parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeDescription
withScoreboolIf set to true, will provide scores in response.
withEnrichmentboolIf set to true, will provide enrichment data in response.
workspaceintThe workspace to score. Required if withScore or withEnrichment is set to true.
\n

Body

\n

Required parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeDescription
contactIdstringThe unique id of the contact.
\n

Optional parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeDescription
emailstringThe email of the contact.
firstNamestringThe first name of the contact.
lastNamestringThe last name of the contact.
ageintThe age of the contact.
avatarstringThe avatar url of the contact.
birthdaystringThe birthday date in format RFC3339
descriptionstringAn description of the contact.
genderstringThe gender of the contact.
ipAddressstringThe ip of the contact.
userAgentstringThe user agent of the contact.
phonestringThe phone number of the contact.
titlestringThe title of the contact.
usernamestringThe username of the contact.
websitestringThe website of the contact.
companyobjectAn object contains company information.
company.namestringThe name of the company.
company.idstringThe id of the company.
company.industrystringThe industry of the company.
company.employeeCountintThe number of employees the company has.
company.domainstringThe domain of the company.
addressobjectAn object contains address information.
address.citystringThe city.
address.countrystringThe country.
address.postalCodestringThe postal code.
address.statestringThe state.
address.streetstringThe street.
propertiesobjectA key-value object that can store custom data about the contact.
createdAtstringThe date and time when the original record was created in format RFC3339. If not specified, current date and time will be used.
\n

Response

\n\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"760aa27b-409f-471d-aa36-9203b9e9f736","id":"760aa27b-409f-471d-aa36-9203b9e9f736","name":"Breadcrumbs Public API - Data collector","type":"collection"}},"urlObject":{"path":["contacts"],"host":["https://api.breadcrumbs.io/collector"],"query":[{"disabled":true,"description":{"content":"

The workspace to score. Required if withScore or withEnrichment is set to true.

\n","type":"text/plain"},"key":"workspace","value":"24"},{"disabled":true,"description":{"content":"

If set to true, will provide scores in response.

\n","type":"text/plain"},"key":"withScore","value":"true"},{"disabled":true,"description":{"content":"

if set to true, will provide enrichment data in response.

\n","type":"text/plain"},"key":"withEnrichment","value":"true"}],"variable":[]}},"response":[{"id":"ff19f2f5-fee1-476d-84f0-047d22993452","name":"Create Contact","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"contactId\": \"1\",\n \"email\": \"demo@breadcrumbs.io\",\n \"firstName\": \"Demo\",\n \"lastName\": \"User\",\n \"age\": 35,\n \"avatar\": \"http://example.com/avatar\",\n \"birthday\": \"1986-10-20T00:00:00+00:00\",\n \"description\": \"Example Description\",\n \"gender\": \"Male\",\n \"ipAddress\": \"87.218.106.169\",\n \"userAgent\": \"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.106 Safari/537.36 OPR/38.0.2220.41\",\n \"phone\": \"3334445556\",\n \"title\": \"Mr\",\n \"username\": \"Example Username\",\n \"website\": \"http://example.com\",\n \"company\":{\n \"name\": \"Example Company name\",\n \"id\": \"5345-2345-385\",\n \"industry\": \"Example Industry\",\n \"employeeCount\": 20,\n \"domain\": \"example.com\"\n },\n \"address\": {\n \"city\": \"Example City\",\n \"country\": \"Example Country\",\n \"postalCode\": \"180210\",\n \"state\": \"Example State\",\n \"street\": \"Example Street\"\n },\n \"properties\": {\n \"test_extra_2\": \"string\",\n \"test_extra_3\": [\n \"nested\"\n ]\n },\n \"createdAt\": \"2021-11-09T15:00:47+00:00\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.breadcrumbs.io/collector/contacts","host":["https://api.breadcrumbs.io/collector"],"path":["contacts"],"query":[{"key":"workspace","value":"10","description":"The workspace to score. Required if withScore is set to true.","disabled":true},{"key":"withScore","value":"true","description":"If set to true, will provide scores in response.","disabled":true}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Created\",\n \"data\": {\n \"contactId\": \"1\",\n \"email\": \"demo@breadcrumbs.io\",\n \"firstName\": \"Demo\",\n \"lastName\": \"User\",\n \"age\": 35,\n \"avatar\": \"http://example.com/avatar\",\n \"birthday\": \"1986-10-20T00:00:00+00:00\",\n \"description\": \"Example Description\",\n \"gender\": \"Male\",\n \"ipAddress\": \"87.218.106.169\",\n \"userAgent\": \"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.106 Safari/537.36 OPR/38.0.2220.41\",\n \"phone\": \"3334445556\",\n \"title\": \"Mr\",\n \"username\": \"Example Username\",\n \"website\": \"http://example.com\",\n \"company\": {\n \"name\": \"Example Company name\",\n \"id\": \"5345-2345-385\",\n \"industry\": \"Example Industry\",\n \"employeeCount\": 20,\n \"domain\": \"example.com\"\n },\n \"address\": {\n \"city\": \"Example City\",\n \"country\": \"Example Country\",\n \"postalCode\": \"180210\",\n \"state\": \"Example State\",\n \"street\": \"Example Street\"\n },\n \"properties\": {\n \"test_extra_2\": \"string\",\n \"test_extra_3\": [\n \"nested\"\n ]\n },\n \"createdAt\": \"2021-11-09T15:00:47+00:00\"\n },\n \"ts\": \"1636367158.835124\",\n \"datetime\": \"2021-11-08T10:25:58+00:00\"\n}"},{"id":"12c11ad4-1151-4b98-b0ff-a4fce8ca5a92","name":"With Realtime Score","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"status\": \"Created\",\n \"data\": { \n \"contactId\": \"1\",\n \"email\": \"demo@breadcrumbs.io\",\n \"firstName\": \"Demo\",\n \"lastName\": \"User\",\n \"age\": 35,\n \"avatar\": \"http://example.com/avatar\",\n \"birthday\": \"1986-10-20T00:00:00+00:00\",\n \"description\": \"Example Description\",\n \"gender\": \"Male\",\n \"ipAddress\": \"87.218.106.169\",\n \"userAgent\": \"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.106 Safari/537.36 OPR/38.0.2220.41\",\n \"phone\": \"3334445556\",\n \"title\": \"Mr\",\n \"username\": \"Example Username\",\n \"website\": \"http://example.com\",\n \"company\":{\n \"name\": \"Example Company name\",\n \"id\": \"5345-2345-385\",\n \"industry\": \"Example Industry\",\n \"employeeCount\": 20,\n \"domain\": \"example.com\"\n },\n \"address\": {\n \"city\": \"Example City\",\n \"country\": \"Example Country\",\n \"postalCode\": \"180210\",\n \"state\": \"Example State\",\n \"street\": \"Example Street\"\n },\n \"properties\": {\n \"test_extra_2\": \"string\",\n \"test_extra_3\": [\n \"nested\"\n ]\n },\n \"createdAt\": \"2021-11-09T15:00:47+00:00\"\n },\n \"ts\": \"1636367158.835124\",\n \"datetime\": \"2021-11-08T10:25:58+00:00\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.breadcrumbs.io/collector/contacts?workspace=10&withScore=true","host":["https://api.breadcrumbs.io/collector"],"path":["contacts"],"query":[{"key":"workspace","value":"10","description":"The workspace to score. Required if withScore is set to true."},{"key":"withScore","value":"true","description":"If set to true, will provide scores in response."}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Created\",\n \"data\": {\n \"contactId\": \"1\",\n \"email\": \"demo@breadcrumbs.io\",\n \"firstName\": \"Demo\",\n \"lastName\": \"User\",\n \"age\": 35,\n \"avatar\": \"http://example.com/avatar\",\n \"birthday\": \"1986-10-20T00:00:00+00:00\",\n \"description\": \"Example Description\",\n \"gender\": \"Male\",\n \"ipAddress\": \"87.218.106.169\",\n \"userAgent\": \"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.106 Safari/537.36 OPR/38.0.2220.41\",\n \"phone\": \"3334445556\",\n \"title\": \"Mr\",\n \"username\": \"Example Username\",\n \"website\": \"http://example.com\",\n \"company\": {\n \"name\": \"Example Company name\",\n \"id\": \"5345-2345-385\",\n \"industry\": \"Example Industry\",\n \"employeeCount\": 20,\n \"domain\": \"example.com\"\n },\n \"address\": {\n \"city\": \"Example City\",\n \"country\": \"Example Country\",\n \"postalCode\": \"180210\",\n \"state\": \"Example State\",\n \"street\": \"Example Street\"\n },\n \"properties\": {\n \"test_extra_2\": \"string\",\n \"test_extra_3\": [\n \"nested\"\n ]\n },\n \"createdAt\": \"2021-11-09T15:00:47+00:00\",\n \"score\": {\n \"process_id\": \"240\",\n \"processed_at\": \"2021-11-04T15:45:52+00:00\",\n \"scores\": [\n {\n \"model_id\": 21,\n \"grade\": \"A1\",\n \"fit_grade\": \"A\",\n \"fit_score\": 100,\n \"activity_grade\": 4,\n \"activity_score\": 100\n }\n ]\n } \n },\n \"ts\": \"1636367158.835124\",\n \"datetime\": \"2021-11-08T10:25:58+00:00\"\n}"},{"id":"a0f25813-1bcc-4352-b2db-bff3d6411338","name":"With Enrichment","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"status\": \"Created\",\n \"data\": { \n \"contactId\": \"1\",\n \"email\": \"demo@breadcrumbs.io\",\n \"firstName\": \"Demo\",\n \"lastName\": \"User\",\n \"age\": 35,\n \"avatar\": \"http://example.com/avatar\",\n \"birthday\": \"1986-10-20T00:00:00+00:00\",\n \"description\": \"Example Description\",\n \"gender\": \"Male\",\n \"ipAddress\": \"87.218.106.169\",\n \"userAgent\": \"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.106 Safari/537.36 OPR/38.0.2220.41\",\n \"phone\": \"3334445556\",\n \"title\": \"Mr\",\n \"username\": \"Example Username\",\n \"website\": \"http://example.com\",\n \"company\":{\n \"name\": \"Example Company name\",\n \"id\": \"5345-2345-385\",\n \"industry\": \"Example Industry\",\n \"employeeCount\": 20,\n \"domain\": \"example.com\"\n },\n \"address\": {\n \"city\": \"Example City\",\n \"country\": \"Example Country\",\n \"postalCode\": \"180210\",\n \"state\": \"Example State\",\n \"street\": \"Example Street\"\n },\n \"properties\": {\n \"test_extra_2\": \"string\",\n \"test_extra_3\": [\n \"nested\"\n ]\n },\n \"createdAt\": \"2021-11-09T15:00:47+00:00\"\n },\n \"ts\": \"1636367158.835124\",\n \"datetime\": \"2021-11-08T10:25:58+00:00\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.breadcrumbs.io/collector/contacts?workspace=10&withScore=true&withEnrichment=true","host":["https://api.breadcrumbs.io/collector"],"path":["contacts"],"query":[{"key":"workspace","value":"10","description":"The workspace to score. Required if withScore or withEnrichment is set to true."},{"key":"withScore","value":"true","description":"If set to true, will provide scores in response."},{"key":"withEnrichment","value":"true","description":"if set to true, will provide enrichment data in response."}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Created\",\n \"data\": {\n \"contactId\": \"1\",\n \"email\": \"demo@breadcrumbs.io\",\n \"firstName\": \"Demo\",\n \"lastName\": \"User\",\n \"age\": 35,\n \"avatar\": \"http://example.com/avatar\",\n \"birthday\": \"1986-10-20T00:00:00+00:00\",\n \"description\": \"Example Description\",\n \"gender\": \"Male\",\n \"ipAddress\": \"87.218.106.169\",\n \"userAgent\": \"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.106 Safari/537.36 OPR/38.0.2220.41\",\n \"phone\": \"3334445556\",\n \"title\": \"Mr\",\n \"username\": \"Example Username\",\n \"website\": \"http://example.com\",\n \"company\": {\n \"name\": \"Example Company name\",\n \"id\": \"5345-2345-385\",\n \"industry\": \"Example Industry\",\n \"employeeCount\": 20,\n \"domain\": \"example.com\"\n },\n \"address\": {\n \"city\": \"Example City\",\n \"country\": \"Example Country\",\n \"postalCode\": \"180210\",\n \"state\": \"Example State\",\n \"street\": \"Example Street\"\n },\n \"properties\": {\n \"test_extra_2\": \"string\",\n \"test_extra_3\": [\n \"nested\"\n ]\n },\n \"createdAt\": \"2021-11-09T15:00:47+00:00\",\n \"score\": {\n \"process_id\": \"240\",\n \"processed_at\": \"2021-11-04T15:45:52+00:00\",\n \"scores\": [\n {\n \"model_id\": 21,\n \"grade\": \"A1\",\n \"fit_grade\": \"A\",\n \"fit_score\": 100,\n \"activity_grade\": 4,\n \"activity_score\": 100\n }\n ]\n },\n \"enrichments\": [\n {\n \"platformId\": 10,\n \"platformConnectionId\": 277,\n \"platformCode\": \"email_verification\",\n \"properties\": {\n \"address\": \"demo@breadcrumbs.io\",\n \"status\": \"valid\",\n \"sub_status\": \"\",\n \"free_email\": true,\n \"did_you_mean\": null,\n \"account\": \"demo\",\n \"domain\": \"breadcrumbs.io\",\n \"domain_age_days\": \"9419\",\n \"smtp_provider\": \"google\",\n \"mx_found\": true,\n \"mx_record\": \"gmail-smtp-in.l.google.com\",\n \"firstname\": null,\n \"lastname\": null,\n \"gender\": null,\n \"country\": null,\n \"region\": null,\n \"city\": null,\n \"zipcode\": null,\n \"processed_at\": \"2021-05-26 14:57:57.652\",\n \"score\": 100,\n \"valid_format\": true,\n \"domain_found\": true,\n \"disposable_email\": false,\n \"role_based_email\": false,\n \"spam_trap_email\": false,\n \"mx_working\": true,\n \"email_smtp_accepted\": true,\n \"smtp_catch_all\": false,\n \"email\": \"bar.foo@gmail.com\"\n },\n \"status\": \"FOUND\",\n \"company\": null\n }\n ] \n },\n \"ts\": \"1636367158.835124\",\n \"datetime\": \"2021-11-08T10:25:58+00:00\"\n}"}],"_postman_id":"ee414150-565e-4a87-8e47-80c2ca61f550"},{"name":"Get Contact","id":"cb9054e6-cf51-4ced-b3ae-fea1e97df0ff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.breadcrumbs.io/collector/contacts/{{contactId}}","description":"

Retrieve a contact.

\n

Query Params

\n

Required parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeDescription
contactIdstringThe unique id of the contact
\n

Response

\n\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"760aa27b-409f-471d-aa36-9203b9e9f736","id":"760aa27b-409f-471d-aa36-9203b9e9f736","name":"Breadcrumbs Public API - Data collector","type":"collection"}},"urlObject":{"path":["contacts","{{contactId}}"],"host":["https://api.breadcrumbs.io/collector"],"query":[],"variable":[]}},"response":[{"id":"7cdf853c-76c7-4ba6-a0fc-3235d00d8b9b","name":"Get Contact","originalRequest":{"method":"GET","header":[],"url":"https://api.breadcrumbs.io/collector/contacts/1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\",\n \"data\": {\n \"contactId\": \"1\",\n \"email\": \"demo@breadcrumbs.io\",\n \"firstName\": \"Demo\",\n \"lastName\": \"User\",\n \"age\": 35,\n \"avatar\": \"http://example.com/avatar\",\n \"birthday\": \"1986-10-20T00:00:00+00:00\",\n \"description\": \"Example Description\",\n \"gender\": \"Male\",\n \"ipAddress\": \"87.218.106.169\",\n \"userAgent\": \"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.106 Safari/537.36 OPR/38.0.2220.41\",\n \"phone\": \"3334445556\",\n \"title\": \"Mr\",\n \"username\": \"Example Username\",\n \"website\": \"http://example.com\",\n \"company\": {\n \"name\": \"Example Company name\",\n \"id\": \"5345-2345-385\",\n \"industry\": \"Example Industry\",\n \"employeeCount\": 20,\n \"domain\": \"example.com\"\n },\n \"address\": {\n \"city\": \"Example City\",\n \"country\": \"Example Country\",\n \"postalCode\": \"180210\",\n \"state\": \"Example State\",\n \"street\": \"Example Street\"\n },\n \"properties\": {\n \"test_extra_2\": \"string\",\n \"test_extra_3\": [\n \"nested\"\n ]\n },\n \"createdAt\": \"2021-11-09T15:00:47+00:00\"\n },\n \"ts\": \"1636367158.835124\",\n \"datetime\": \"2021-11-08T10:25:58+00:00\"\n}"}],"_postman_id":"cb9054e6-cf51-4ced-b3ae-fea1e97df0ff"},{"name":"Get Contact Scores History","id":"a9906544-1e7a-4ec8-aec8-a09a756dfaa4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.breadcrumbs.io/collector/contacts/{{contactId}}/scores","description":"

Query Params

\n

Required parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeDescription
workspaceintThe workspace from which to retrieve the scores
contactIdstringThe unique id of the contact
\n

Optional parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeDescription
sizeintThe number of scores to retrieve. Max:10, Default:1
modelintRetrieves the scores for this model only.
\n

Response

\n\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"760aa27b-409f-471d-aa36-9203b9e9f736","id":"760aa27b-409f-471d-aa36-9203b9e9f736","name":"Breadcrumbs Public API - Data collector","type":"collection"}},"urlObject":{"path":["contacts","{{contactId}}","scores"],"host":["https://api.breadcrumbs.io/collector"],"query":[{"disabled":true,"description":{"content":"

The number of scores to retrieve. Max:10, Default:1

\n","type":"text/plain"},"key":"size","value":"10"},{"disabled":true,"description":{"content":"

Retrieves the scores for this model only.

\n","type":"text/plain"},"key":"model","value":""},{"disabled":true,"description":{"content":"

The workspace from which to retrieve the scores

\n","type":"text/plain"},"key":"workspace","value":"24"}],"variable":[]}},"response":[{"id":"83dcfdc2-b0cb-4f89-836c-265aa081d175","name":"Scores","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.breadcrumbs.io/collector/contacts/bcf4d7a05e8d28aa39eeedb17ac7db84/scores?size=1&model=21&workspace=22","host":["https://api.breadcrumbs.io/collector"],"path":["contacts","bcf4d7a05e8d28aa39eeedb17ac7db84","scores"],"query":[{"key":"size","value":"1","description":"The number of scores to retrieve. Max:10, Default:1"},{"key":"model","value":"21","description":"Retrieves the scores for this model only."},{"key":"workspace","value":"22","description":"The workspace from which to retrieve the scores"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\",\n \"data\": [\n {\n \"process_id\": \"240\",\n \"processed_at\": \"2021-11-04T15:45:52+00:00\",\n \"scores\": [\n {\n \"model_id\": 21,\n \"grade\": \"A4\",\n \"fit_grade\": \"A\",\n \"fit_score\": 100,\n \"activity_grade\": 4,\n \"activity_score\": 0\n }\n ]\n },\n {\n \"process_id\": \"239\",\n \"processed_at\": \"2021-11-03T15:45:00+00:00\",\n \"scores\": [\n {\n \"model_id\": 21,\n \"grade\": \"A4\",\n \"fit_grade\": \"A\",\n \"fit_score\": 87,\n \"activity_grade\": 4,\n \"activity_score\": 0\n }\n ]\n }\n ],\n \"ts\": \"1636367158.835124\",\n \"datetime\": \"2021-11-08T10:25:58+00:00\"\n}"}],"_postman_id":"a9906544-1e7a-4ec8-aec8-a09a756dfaa4"},{"name":"Delete Contact","id":"e70b740c-38b4-4366-98a8-85afd09082ca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.breadcrumbs.io/collector/contacts/{{contactId}}","description":"

Delete a contact.

\n

Query Params

\n

Required parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeDescription
contactIdstringThe unique id of the contact
\n

Response

\n\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"760aa27b-409f-471d-aa36-9203b9e9f736","id":"760aa27b-409f-471d-aa36-9203b9e9f736","name":"Breadcrumbs Public API - Data collector","type":"collection"}},"urlObject":{"path":["contacts","{{contactId}}"],"host":["https://api.breadcrumbs.io/collector"],"query":[],"variable":[]}},"response":[{"id":"7e9f2a1f-1cda-4e03-9a7a-c03226a5f9a8","name":"Delete Contact","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.breadcrumbs.io/collector/contacts/{{contactId}}"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"e70b740c-38b4-4366-98a8-85afd09082ca"}],"id":"c46a8788-6479-46e3-aead-6e3a3ad83375","_postman_id":"c46a8788-6479-46e3-aead-6e3a3ad83375","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"760aa27b-409f-471d-aa36-9203b9e9f736","id":"760aa27b-409f-471d-aa36-9203b9e9f736","name":"Breadcrumbs Public API - Data collector","type":"collection"}}},{"name":"Activities","item":[{"name":"Create Activity","id":"c51a2470-6195-46aa-a2ed-b138fc906bc4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"activityName\": \"Test activity\",\n \"createdAt\": \"2021-11-09T15:00:47+00:00\",\n \"properties\": {\n \"test_extra_1\": 1,\n \"test_extra_2\": \"string\",\n \"test_extra_3\": [\n \"nested\"\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.breadcrumbs.io/collector/contacts/:contactId/activities","description":"

Create a contact activity

\n

Query Params

\n

Required parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeDescription
contactIdstringThe unique id of the contact
\n

Body

\n

Required parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeDescription
activityNamestringThe name of the activity
\n

Optional parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeDescription
createdAtstringThe date and time when the original record was created in format RFC3339. If not specified, current date and time will be used.
propertiesobjectA key-value object that can store custom data about the activity.
\n

Response

\n\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"760aa27b-409f-471d-aa36-9203b9e9f736","id":"760aa27b-409f-471d-aa36-9203b9e9f736","name":"Breadcrumbs Public API - Data collector","type":"collection"}},"urlObject":{"path":["contacts",":contactId","activities"],"host":["https://api.breadcrumbs.io/collector"],"query":[],"variable":[{"type":"any","value":null,"key":"contactId"}]}},"response":[{"id":"b226f2a7-2ed9-4f02-8b24-7fa43b06b197","name":"Create Activity","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"activityName\": \"Test activity\",\n \"createdAt\": \"2021-11-09T15:00:47+00:00\",\n \"properties\": {\n \"test_extra_1\": 1,\n \"test_extra_2\": \"string\",\n \"test_extra_3\": [\n \"nested\"\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.breadcrumbs.io/collector/contacts/1/activities"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Created\",\n \"data\": {\n \"activityId\": \"724bee4a-343a-49df-a5bd-55172181ec48\",\n \"activityName\": \"Test activity\",\n \"contactId\": \"1\",\n \"createdAt\": \"2021-11-09T15:00:47+00:00\",\n \"properties\": {\n \"test_extra_1\": 1,\n \"test_extra_2\": \"string\",\n \"test_extra_3\": [\n \"nested\"\n ]\n }\n },\n \"ts\": \"1636477006.370632\",\n \"datetime\": \"2021-11-09T16:56:46+00:00\"\n}"}],"_postman_id":"c51a2470-6195-46aa-a2ed-b138fc906bc4"},{"name":"Create/Update Activity","id":"2d8f6c43-606e-4391-ab27-5fb4b2d868a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"activityName\": \"Test activity\",\n \"contactId\": \"{{contactId}}\",\n \"createdAt\": \"2021-11-09T15:00:47+00:00\",\n \"properties\": {\n \"test_extra_1\": 1,\n \"test_extra_2\": \"string\",\n \"test_extra_3\": [\n \"nested\"\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.breadcrumbs.io/collector/activities/{{activityId}}","description":"

Create or update a contact activity

\n

Query Params

\n

Required parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeDescription
activityIdstringThe unique id of the activity
\n

Body

\n

Required parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeDescription
activityNamestringThe name of the activity
contactIdstringThe unique id of the contact
\n

Optional parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeDescription
createdAtstringThe date and time when the original record was created in format RFC3339. If not specified, current date and time will be used.
propertiesobjectA key-value object that can store custom data about the activity.
\n

Response

\n\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"760aa27b-409f-471d-aa36-9203b9e9f736","id":"760aa27b-409f-471d-aa36-9203b9e9f736","name":"Breadcrumbs Public API - Data collector","type":"collection"}},"urlObject":{"path":["activities","{{activityId}}"],"host":["https://api.breadcrumbs.io/collector"],"query":[],"variable":[]}},"response":[{"id":"638863f8-a190-4368-9e0e-527663cec790","name":"Create/Update Activity","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"activityName\": \"Test activity\",\n \"contactId\": \"1\",\n \"createdAt\": \"2021-11-09T15:00:47+00:00\",\n \"properties\": {\n \"test_extra_1\": 1,\n \"test_extra_2\": \"string\",\n \"test_extra_3\": [\n \"nested\"\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.breadcrumbs.io/collector/activities/25a0d76f-fbac-708c-f73b-3b12d3acchc7"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\",\n \"data\": {\n \"activityId\": \"25a0d76f-fbac-708c-f73b-3b12d3acchc7\",\n \"activityName\": \"Test activity\",\n \"contactId\": \"1\",\n \"createdAt\": \"2021-11-09T15:00:47+00:00\",\n \"properties\": {\n \"test_extra_1\": 1,\n \"test_extra_2\": \"string\",\n \"test_extra_3\": [\n \"nested\"\n ]\n }\n },\n \"ts\": \"1636367158.835124\",\n \"datetime\": \"2021-11-08T10:25:58+00:00\"\n}"}],"_postman_id":"2d8f6c43-606e-4391-ab27-5fb4b2d868a7"},{"name":"Delete Activity","id":"c94f37e5-1c72-41fe-b333-6f1267fc9b5c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.breadcrumbs.io/collector/activities/{{activityId}}","description":"

Delete an activity.

\n

BETA feature - please contact us at dev@breadcrumbs.io to get early access to this feature

\n

Query Params

\n

Required parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeDescription
activityIdstringThe unique id of the activity
\n

Response

\n\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"760aa27b-409f-471d-aa36-9203b9e9f736","id":"760aa27b-409f-471d-aa36-9203b9e9f736","name":"Breadcrumbs Public API - Data collector","type":"collection"}},"urlObject":{"path":["activities","{{activityId}}"],"host":["https://api.breadcrumbs.io/collector"],"query":[],"variable":[]}},"response":[{"id":"b79d2121-a188-4b7c-a75f-6627513e196e","name":"Delete Activity","originalRequest":{"method":"DELETE","header":[],"url":"https://api.breadcrumbs.io/collector/activities/724bee4a-343a-49df-a5bd-55172181ec48"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"c94f37e5-1c72-41fe-b333-6f1267fc9b5c"}],"id":"84f295cb-cf20-4d29-864b-5523b0391f24","_postman_id":"84f295cb-cf20-4d29-864b-5523b0391f24","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"760aa27b-409f-471d-aa36-9203b9e9f736","id":"760aa27b-409f-471d-aa36-9203b9e9f736","name":"Breadcrumbs Public API - Data collector","type":"collection"}}},{"name":"Lists","item":[{"name":"Get Lists","id":"0ffa72c8-3d66-40a4-8945-9c40b9bf7ebe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.breadcrumbs.io/collector/lists","description":"

Get Lists

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"760aa27b-409f-471d-aa36-9203b9e9f736","id":"760aa27b-409f-471d-aa36-9203b9e9f736","name":"Breadcrumbs Public API - Data collector","type":"collection"}},"urlObject":{"path":["lists"],"host":["https://api.breadcrumbs.io/collector"],"query":[],"variable":[]}},"response":[{"id":"533d3b62-b897-4b46-9a52-45a5fa4c6b7a","name":"Lists","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ...","type":"text"}],"url":"https://api.breadcrumbs.io/collector/lists"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\",\n \"data\": [\n {\n \"id\": \"example_list\",\n \"label\": \"Example List\",\n \"createdAt\": \"2021-11-11T17:05:16+00:00\"\n },\n {\n \"id\": \"exmaple_list2\",\n \"label\": \"Example List2\",\n \"createdAt\": \"2021-11-11T17:05:16+00:00\"\n }\n ],\n \"ts\": \"1636367158.835124\",\n \"datetime\": \"2021-11-08T10:25:58+00:00\"\n}"}],"_postman_id":"0ffa72c8-3d66-40a4-8945-9c40b9bf7ebe"},{"name":"Create/Update Contact in List","id":"6a639257-17cc-4e44-90d8-7d7c4ff437a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"email\": \"demo@breadcrumbs.io\",\n \"firstName\": \"Demo\",\n \"lastName\": \"User\",\n \"age\": 35,\n \"avatar\": \"http://example.com/avatar\",\n \"birthday\": \"1986-10-20T00:00:00+00:00\",\n \"description\": \"Example Description\",\n \"gender\": \"Male\",\n \"ipAddress\": \"87.218.106.169\",\n \"userAgent\": \"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.106 Safari/537.36 OPR/38.0.2220.41\",\n \"phone\": \"3334445556\",\n \"title\": \"Mr\",\n \"username\": \"Example Username\",\n \"website\": \"http://example.com\",\n \"company\":{\n \"name\": \"Example Company name\",\n \"id\": \"5345-2345-385\",\n \"industry\": \"Example Industry\",\n \"employeeCount\": 20,\n \"domain\": \"example.com\"\n },\n \"address\": {\n \"city\": \"Example City\",\n \"country\": \"Example Country\",\n \"postalCode\": \"180210\",\n \"state\": \"Example State\",\n \"street\": \"Example Street\"\n },\n \"properties\": {\n \"test_extra_2\": \"string\",\n \"test_extra_3\": [\n \"nested\"\n ]\n },\n \"createdAt\": \"2021-11-09T15:00:47+00:00\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.breadcrumbs.io/collector/lists/{{listId}}/contacts/{{contactId}}","description":"

Create or update a contact and associate it with a list (the list will be created if it does not exist).

\n

Query Params

\n

Required parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeDescription
contactIdstringThe unique id of the contact
listIdstringThe unique id of the list
\n

Optional parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeDescription
withScoreboolIf set to true, will provide scores in response.
withEnrichmentboolIf set to true, will provide enrichment in response.
workspaceintThe workspace to score. Required if withScore or withEnrichment is set to true.
\n

Body

\n

Optional parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeDescription
emailstringThe email of the contact.
firstNamestringThe first name of the contact.
lastNamestringThe last name of the contact.
ageintThe age of the contact.
avatarstringThe avatar url of the contact.
birthdaystringThe birthday date in format RFC3339
descriptionstringAn description of the contact.
genderstringThe gender of the contact.
ipAddressstringThe ip of the contact.
userAgentstringThe user agent of the contact.
phonestringThe phone number of the contact.
titlestringThe title of the contact.
usernamestringThe username of the contact.
websitestringThe website of the contact.
companyobjectAn object contains company information.
company.namestringThe name of the company.
company.idstringThe id of the company.
company.industrystringThe industry of the company.
company.employeeCountintThe number of employees the company has.
company.domainstringThe domain of the company.
addressobjectAn object contains address information.
address.citystringThe city.
address.countrystringThe country.
address.postalCodestringThe postal code.
address.statestringThe state.
address.streetstringThe street.
propertiesobjectA key-value object that can store custom data about the contact.
createdAtstringThe date and time when the original record was created in format RFC3339. If not specified, current date and time will be used.
\n

Response

\n\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"760aa27b-409f-471d-aa36-9203b9e9f736","id":"760aa27b-409f-471d-aa36-9203b9e9f736","name":"Breadcrumbs Public API - Data collector","type":"collection"}},"urlObject":{"path":["lists","{{listId}}","contacts","{{contactId}}"],"host":["https://api.breadcrumbs.io/collector"],"query":[{"disabled":true,"description":{"content":"

The workspace to score. Required if withScore or withEnrichment is set to true.

\n","type":"text/plain"},"key":"workspace","value":"24"},{"disabled":true,"description":{"content":"

If set to true, will provide scores in response.

\n","type":"text/plain"},"key":"withScore","value":"true"},{"disabled":true,"description":{"content":"

if set to true, will provide enrichment in response.

\n","type":"text/plain"},"key":"withEnrichment","value":"true"}],"variable":[]}},"response":[{"id":"58e78e79-6c8b-4170-ae36-88c9495155b2","name":"With Realtime Score","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ....","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\": \"demo@breadcrumbs.io\",\n \"first_name\": \"Demo\",\n \"last_name\": \"User\",\n \"company_name\": \"Breadcrumbs\",\n \"company_domain\": \"breadcrumbs.io\",\n \"phone\": \"3334445556\",\n \"created_at\": \"2021-10-20 16:00:00\",\n \"properties\": {\n \"test_extra_1\": 1,\n \"test_extra_2\": \"string\",\n \"test_extra_3\": [\n \"nested\"\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.breadcrumbs.io/collector/lists/test_list/contacts/1?workspace=33&withScore=true","host":["https://api.breadcrumbs.io/collector"],"path":["lists","test_list","contacts","1"],"query":[{"key":"workspace","value":"33","description":"The workspace to score. Required if withScore is set to true."},{"key":"withScore","value":"true","description":"If set to true, will provide scores in response."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": \"200 OK\",\n \"data\": {\n \"contactId\": \"1\",\n \"email\": \"demo@breadcrumbs.io\",\n \"firstName\": \"Demo\",\n \"lastName\": \"User\",\n \"age\": 35,\n \"avatar\": \"http://example.com/avatar\",\n \"birthday\": \"1986-10-20T00:00:00+00:00\",\n \"description\": \"Example Description\",\n \"gender\": \"Male\",\n \"ipAddress\": \"87.218.106.169\",\n \"userAgent\": \"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.106 Safari/537.36 OPR/38.0.2220.41\",\n \"phone\": \"3334445556\",\n \"title\": \"Mr\",\n \"username\": \"Example Username\",\n \"website\": \"http://example.com\",\n \"company\": {\n \"name\": \"Example Company name\",\n \"id\": \"5345-2345-385\",\n \"industry\": \"Example Industry\",\n \"employeeCount\": 20,\n \"domain\": \"example.com\"\n },\n \"address\": {\n \"city\": \"Example City\",\n \"country\": \"Example Country\",\n \"postalCode\": \"180210\",\n \"state\": \"Example State\",\n \"street\": \"Example Street\"\n },\n \"properties\": {\n \"test_extra_2\": \"string\",\n \"test_extra_3\": [\n \"nested\"\n ]\n },\n \"createdAt\": \"2021-11-09T15:00:47+00:00\",\n \"score\": {\n \"process_id\": null,\n \"processed_at\": \"2021-11-04T15:45:52+00:00\",\n \"scores\": [\n {\n \"model_id\": 21,\n \"grade\": \"A1\",\n \"fit_grade\": \"A\",\n \"fit_score\": 100,\n \"activity_grade\": 4,\n \"activity_score\": 100\n }\n ]\n } \n },\n \"ts\": \"1636367158.835124\",\n \"datetime\": \"2021-11-08T10:25:58+00:00\"\n}"},{"id":"95fd89e7-3a35-497c-9112-3b10ca4324e0","name":"With Enrichment","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ....","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\": \"demo@breadcrumbs.io\",\n \"first_name\": \"Demo\",\n \"last_name\": \"User\",\n \"company_name\": \"Breadcrumbs\",\n \"company_domain\": \"breadcrumbs.io\",\n \"phone\": \"3334445556\",\n \"created_at\": \"2021-10-20 16:00:00\",\n \"properties\": {\n \"test_extra_1\": 1,\n \"test_extra_2\": \"string\",\n \"test_extra_3\": [\n \"nested\"\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.breadcrumbs.io/collector/lists/test_list/contacts/1?workspace=33&withScore=true&withEnrichment=true","host":["https://api.breadcrumbs.io/collector"],"path":["lists","test_list","contacts","1"],"query":[{"key":"workspace","value":"33","description":"The workspace to score. Required if withScore or withEnrichment is set to true."},{"key":"withScore","value":"true","description":"If set to true, will provide scores in response."},{"key":"withEnrichment","value":"true","description":"if set to true, will provide enrichment data in response."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": \"200 OK\",\n \"data\": {\n \"contactId\": \"1\",\n \"email\": \"demo@breadcrumbs.io\",\n \"firstName\": \"Demo\",\n \"lastName\": \"User\",\n \"age\": 35,\n \"avatar\": \"http://example.com/avatar\",\n \"birthday\": \"1986-10-20T00:00:00+00:00\",\n \"description\": \"Example Description\",\n \"gender\": \"Male\",\n \"ipAddress\": \"87.218.106.169\",\n \"userAgent\": \"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.106 Safari/537.36 OPR/38.0.2220.41\",\n \"phone\": \"3334445556\",\n \"title\": \"Mr\",\n \"username\": \"Example Username\",\n \"website\": \"http://example.com\",\n \"company\": {\n \"name\": \"Example Company name\",\n \"id\": \"5345-2345-385\",\n \"industry\": \"Example Industry\",\n \"employeeCount\": 20,\n \"domain\": \"example.com\"\n },\n \"address\": {\n \"city\": \"Example City\",\n \"country\": \"Example Country\",\n \"postalCode\": \"180210\",\n \"state\": \"Example State\",\n \"street\": \"Example Street\"\n },\n \"properties\": {\n \"test_extra_2\": \"string\",\n \"test_extra_3\": [\n \"nested\"\n ]\n },\n \"createdAt\": \"2021-11-09T15:00:47+00:00\",\n \"score\": {\n \"process_id\": null,\n \"processed_at\": \"2021-11-04T15:45:52+00:00\",\n \"scores\": [\n {\n \"model_id\": 21,\n \"grade\": \"A1\",\n \"fit_grade\": \"A\",\n \"fit_score\": 100,\n \"activity_grade\": 4,\n \"activity_score\": 100\n }\n ]\n },\n \"enrichments\": [\n {\n \"platformId\": 10,\n \"platformConnectionId\": 277,\n \"platformCode\": \"email_verification\",\n \"properties\": {\n \"address\": \"demo@breadcrumbs.io\",\n \"status\": \"valid\",\n \"sub_status\": \"\",\n \"free_email\": true,\n \"did_you_mean\": null,\n \"account\": \"demo\",\n \"domain\": \"breadcrumbs.io\",\n \"domain_age_days\": \"9419\",\n \"smtp_provider\": \"google\",\n \"mx_found\": true,\n \"mx_record\": \"gmail-smtp-in.l.google.com\",\n \"firstname\": null,\n \"lastname\": null,\n \"gender\": null,\n \"country\": null,\n \"region\": null,\n \"city\": null,\n \"zipcode\": null,\n \"processed_at\": \"2021-05-26 14:57:57.652\",\n \"score\": 100,\n \"valid_format\": true,\n \"domain_found\": true,\n \"disposable_email\": false,\n \"role_based_email\": false,\n \"spam_trap_email\": false,\n \"mx_working\": true,\n \"email_smtp_accepted\": true,\n \"smtp_catch_all\": false,\n \"email\": \"bar.foo@gmail.com\"\n },\n \"status\": \"FOUND\",\n \"company\": null\n }\n ] \n },\n \"ts\": \"1636367158.835124\",\n \"datetime\": \"2021-11-08T10:25:58+00:00\"\n}"}],"_postman_id":"6a639257-17cc-4e44-90d8-7d7c4ff437a7"},{"name":"Delete List","id":"258edafa-420f-4a88-800a-d582da82e86e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.breadcrumbs.io/collector/lists/{{listId}}","description":"

Delete a list.

\n

Query Params

\n

Required parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeDescription
listIdstringThe unique id of the list
\n

Response

\n\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"760aa27b-409f-471d-aa36-9203b9e9f736","id":"760aa27b-409f-471d-aa36-9203b9e9f736","name":"Breadcrumbs Public API - Data collector","type":"collection"}},"urlObject":{"path":["lists","{{listId}}"],"host":["https://api.breadcrumbs.io/collector"],"query":[],"variable":[]}},"response":[{"id":"f73444e7-0793-495a-b994-e030721e3b27","name":"Delete List","originalRequest":{"method":"DELETE","header":[],"url":"https://api.breadcrumbs.io/collector/lists/1"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"258edafa-420f-4a88-800a-d582da82e86e"},{"name":"Remove Contact from List","id":"ee02d721-0cbd-479c-8918-562298ce12e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.breadcrumbs.io/collector/lists/{{listId}}/contacts/{{contactId}}","description":"

Remove contact from list.

\n

Query Params

\n

Required parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeDescription
contactIdstringThe unique id of the contact
listIdstringThe unique id of the list
\n

Response

\n\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"760aa27b-409f-471d-aa36-9203b9e9f736","id":"760aa27b-409f-471d-aa36-9203b9e9f736","name":"Breadcrumbs Public API - Data collector","type":"collection"}},"urlObject":{"path":["lists","{{listId}}","contacts","{{contactId}}"],"host":["https://api.breadcrumbs.io/collector"],"query":[],"variable":[]}},"response":[{"id":"3226626e-324a-4ef7-925c-4f5a5065a490","name":"Remove Contact from List","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.breadcrumbs.io/collector/lists/{{listId}}/contacts/{{contactId}}"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"ee02d721-0cbd-479c-8918-562298ce12e5"},{"name":"Create List","id":"ec4a123c-74e8-42bd-8baa-8b52758a3fe2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"id\": \"example_list\",\n \"label\": \"Example List\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.breadcrumbs.io/collector/lists","description":"

Create a list.

\n

BETA feature - please contact us at dev@breadcrumbs.io to get early access to this feature

\n

Body

\n

Required parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeDescription
idstringThe unique id of the list.
\n

Optional parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeDescription
labelstringThe label of the list.
\n

Response

\n\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"760aa27b-409f-471d-aa36-9203b9e9f736","id":"760aa27b-409f-471d-aa36-9203b9e9f736","name":"Breadcrumbs Public API - Data collector","type":"collection"}},"urlObject":{"path":["lists"],"host":["https://api.breadcrumbs.io/collector"],"query":[],"variable":[]}},"response":[{"id":"353c8d5a-2418-42bb-82a2-d1275a6900fb","name":"Create List","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"example_list\",\n \"label\": \"Example List\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.breadcrumbs.io/collector/lists"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Created\",\n \"data\": {\n \"id\": \"example_list\",\n \"label\": \"Example List\",\n \"createdAt\": \"2021-11-11T17:05:16+00:00\"\n },\n \"ts\": \"1636367158.835124\",\n \"datetime\": \"2021-11-08T10:25:58+00:00\"\n}"}],"_postman_id":"ec4a123c-74e8-42bd-8baa-8b52758a3fe2"},{"name":"Associates a Contact with a List","id":"056eac99-2cd6-46e3-b15a-3df69a35a6ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"listId\": \"example_list\",\n \"contactId\": \"1\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.breadcrumbs.io/collector/lists/associate","description":"

Associates a contact with a list.

\n

BETA feature - please contact us at dev@breadcrumbs.io to get early access to this feature

\n

Body

\n

Required parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeDescription
listIdstringThe unique id of the list.
contactIdstringThe unique id of the contact.
\n

Response

\n\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"760aa27b-409f-471d-aa36-9203b9e9f736","id":"760aa27b-409f-471d-aa36-9203b9e9f736","name":"Breadcrumbs Public API - Data collector","type":"collection"}},"urlObject":{"path":["lists","associate"],"host":["https://api.breadcrumbs.io/collector"],"query":[],"variable":[]}},"response":[{"id":"98ecbac4-8b6f-44bd-8c0e-06ef8299f763","name":"Associates a Contact with a List","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"listId\": \"example_list\",\n \"contactId\": \"1\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.breadcrumbs.io/collector/lists"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Created\",\n \"data\": {\n \"listId\": \"example_list\",\n \"contactId\": \"1\",\n \"createdAt\": \"2021-11-11T17:05:16+00:00\"\n },\n \"ts\": \"1636367158.835124\",\n \"datetime\": \"2021-11-08T10:25:58+00:00\"\n}"}],"_postman_id":"056eac99-2cd6-46e3-b15a-3df69a35a6ec"}],"id":"53d8d840-0f83-4f67-ab80-3968f42e8dc1","_postman_id":"53d8d840-0f83-4f67-ab80-3968f42e8dc1","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"760aa27b-409f-471d-aa36-9203b9e9f736","id":"760aa27b-409f-471d-aa36-9203b9e9f736","name":"Breadcrumbs Public API - Data collector","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"d8e1a0cd-216a-4a94-8529-7a35ae1ab3c2","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e301d538-8e3a-4413-a6e9-ea42ed85bfd1","type":"text/javascript","exec":[""]}}],"variable":[{"key":"endpoint","value":"https://api.breadcrumbs.io/collector"},{"key":"access_token","value":""}]}