Is the API documentation wrong? Because this doesn't work

frankebailey at June 19th, 2018 10:36 — #1

It says in the API docs that the "search" parameter works as follows:

Only contacts having this phrase in phone, first, last or company name will be returned.

However when I use the API browser and hit

https://app.onepagecrm.com/api/v3/contacts.json?search=abacus

I don't even get contacts back, I just get a generic resultset containing all the settings for my account. This doesn't seem like it should be happening.

Any help please?

kevin at June 22nd, 2018 04:20 — #2

Hi Frank,

I am having a little trouble duplicating your problem.

when i query:

../api/v3/contacts.json?search=Morgan's Forensic Lab

I see 6 contacts returned as well as lead sources, statuses, tags, etc.

If the search param doesn't match any contacts details then you should get an empty contacts array in the data hash as well as lead sources, statuses, tags, etc.

Can you confirm that you indeed have contacts where first, last or company name is "abacus". Failing this, would you mind providing a sample output of your request?

Thank you,

Kevin

frankebailey at June 24th, 2018 09:40 — #3

Hi Kevin,

I have two companies called 'Abacus Truck & Trailer Sales'. One with 'cc' on the end and one not. So at the very least those two should be returned, but I only get the standard settings response back:

https://app.onepagecrm.com/api/v3/contacts.json?search=abacus

The full response is:

{
"status": 0,
"message": "OK",
"timestamp": 1529845354,
"data": {
"contacts": [],
"total_count": 0,
"page": 1,
"per_page": 10,
"max_page": 1
},
"lead_sources": [
{
"id": "5a843b3caa76201c7929ab9a",
"text": "ATN Website",
"counts": 0,
"total_count": 1,
"action_stream_count": 0,
"team_counts": [
{
"user_id": "5a6b0bf7aa7620bd07dfdd54",
"counts": 0
},
{
"user_id": "5a8432c8aa7620589026b730",
"counts": 0
},
{
"user_id": "5a93dc57aa762089fa2b0f01",
"counts": 1
},
{
"user_id": "5a93e279aa76202ba5311150",
"counts": 0
},
{
"user_id": "5a994f8daa7620e9aa3734fc",
"counts": 0
}
]
},
{
"id": "5abcb5c4aa76202a52f368a0",
"text": "Auto Trader",
"counts": 0,
"total_count": 88,
"action_stream_count": 0,
"team_counts": [
{
"user_id": "5a6b0bf7aa7620bd07dfdd54",
"counts": 0
},
{
"user_id": "5a8432c8aa7620589026b730",
"counts": 0
},
{
"user_id": "5a93dc57aa762089fa2b0f01",
"counts": 88
},
{
"user_id": "5a93e279aa76202ba5311150",
"counts": 0
},
{
"user_id": "5a994f8daa7620e9aa3734fc",
"counts": 0
}
]
},
{
"id": "5a843bb8aa76201c7929c11c",
"text": "Cold Call",
"counts": 0,
"total_count": 0,
"action_stream_count": 0,
"team_counts": [
{
"user_id": "5a6b0bf7aa7620bd07dfdd54",
"counts": 0
},
{
"user_id": "5a8432c8aa7620589026b730",
"counts": 0
},
{
"user_id": "5a93dc57aa762089fa2b0f01",
"counts": 0
},
{
"user_id": "5a93e279aa76202ba5311150",
"counts": 0
},
{
"user_id": "5a994f8daa7620e9aa3734fc",
"counts": 0
}
]
},
{
"id": "5abcb55baa76202a52f3484f",
"text": "Cold Canvas",
"counts": 0,
"total_count": 7,
"action_stream_count": 0,
"team_counts": [
{
"user_id": "5a6b0bf7aa7620bd07dfdd54",
"counts": 0
},
{
"user_id": "5a8432c8aa7620589026b730",
"counts": 0
},
{
"user_id": "5a93dc57aa762089fa2b0f01",
"counts": 7
},
{
"user_id": "5a93e279aa76202ba5311150",
"counts": 0
},
{
"user_id": "5a994f8daa7620e9aa3734fc",
"counts": 0
}
]
},
{
"id": "tradeshow",
"text": "Commercial Trader",
"counts": 0,
"total_count": 0,
"action_stream_count": 0,
"team_counts": [
{
"user_id": "5a6b0bf7aa7620bd07dfdd54",
"counts": 0
},
{
"user_id": "5a8432c8aa7620589026b730",
"counts": 0
},
{
"user_id": "5a93dc57aa762089fa2b0f01",
"counts": 0
},
{
"user_id": "5a93e279aa76202ba5311150",
"counts": 0
},
{
"user_id": "5a994f8daa7620e9aa3734fc",
"counts": 0
}
]
},
{
"id": "5a843bb8aa76201c7929c11d",
"text": "Email Campaign",
"counts": 0,
"total_count": 0,
"action_stream_count": 0,
"team_counts": [
{
"user_id": "5a6b0bf7aa7620bd07dfdd54",
"counts": 0
},
{
"user_id": "5a8432c8aa7620589026b730",
"counts": 0
},
{
"user_id": "5a93dc57aa762089fa2b0f01",
"counts": 0
},
{
"user_id": "5a93e279aa76202ba5311150",
"counts": 0
},
{
"user_id": "5a994f8daa7620e9aa3734fc",
"counts": 0
}
]
},
{
"id": "advertisement",
"text": "Facebook",
"counts": 0,
"total_count": 0,
"action_stream_count": 0,
"team_counts": [
{
"user_id": "5a6b0bf7aa7620bd07dfdd54",
"counts": 0
},
{
"user_id": "5a8432c8aa7620589026b730",
"counts": 0
},
{
"user_id": "5a93dc57aa762089fa2b0f01",
"counts": 0
},
{
"user_id": "5a93e279aa76202ba5311150",
"counts": 0
},
{
"user_id": "5a994f8daa7620e9aa3734fc",
"counts": 0
}
]
},
{
"id": "5a843b93aa76207eae26e380",
"text": "Referral",
"counts": 0,
"total_count": 2,
"action_stream_count": 0,
"team_counts": [
{
"user_id": "5a6b0bf7aa7620bd07dfdd54",
"counts": 1
},
{
"user_id": "5a8432c8aa7620589026b730",
"counts": 0
},
{
"user_id": "5a93dc57aa762089fa2b0f01",
"counts": 0
},
{
"user_id": "5a93e279aa76202ba5311150",
"counts": 0
},
{
"user_id": "5a994f8daa7620e9aa3734fc",
"counts": 1
}
]
},
{
"id": "5a843b93aa76207eae26e37f",
"text": "Repeat",
"counts": 0,
"total_count": 33,
"action_stream_count": 0,
"team_counts": [
{
"user_id": "5a6b0bf7aa7620bd07dfdd54",
"counts": 0
},
{
"user_id": "5a8432c8aa7620589026b730",
"counts": 0
},
{
"user_id": "5a93dc57aa762089fa2b0f01",
"counts": 32
},
{
"user_id": "5a93e279aa76202ba5311150",
"counts": 0
},
{
"user_id": "5a994f8daa7620e9aa3734fc",
"counts": 1
}
]
},
{
"id": "referral",
"text": "Truck & Trailer",
"counts": 0,
"total_count": 106,
"action_stream_count": 0,
"team_counts": [
{
"user_id": "5a6b0bf7aa7620bd07dfdd54",
"counts": 0
},
{
"user_id": "5a8432c8aa7620589026b730",
"counts": 0
},
{
"user_id": "5a93dc57aa762089fa2b0f01",
"counts": 105
},
{
"user_id": "5a93e279aa76202ba5311150",
"counts": 0
},
{
"user_id": "5a994f8daa7620e9aa3734fc",
"counts": 1
}
]
},
{
"id": "5a843b57aa76207eae26de08",
"text": "TruckFix Website",
"counts": 0,
"total_count": 0,
"action_stream_count": 0,
"team_counts": [
{
"user_id": "5a6b0bf7aa7620bd07dfdd54",
"counts": 0
},
{
"user_id": "5a8432c8aa7620589026b730",
"counts": 0
},
{
"user_id": "5a93dc57aa762089fa2b0f01",
"counts": 0
},
{
"user_id": "5a93e279aa76202ba5311150",
"counts": 0
},
{
"user_id": "5a994f8daa7620e9aa3734fc",
"counts": 0
}
]
},
{
"id": "social",
"text": "Walk-in",
"counts": 0,
"total_count": 11,
"action_stream_count": 0,
"team_counts": [
{
"user_id": "5a6b0bf7aa7620bd07dfdd54",
"counts": 0
},
{
"user_id": "5a8432c8aa7620589026b730",
"counts": 0
},
{
"user_id": "5a93dc57aa762089fa2b0f01",
"counts": 10
},
{
"user_id": "5a93e279aa76202ba5311150",
"counts": 0
},
{
"user_id": "5a994f8daa7620e9aa3734fc",
"counts": 1
}
]
},
{
"id": "5abcb5e6aa762028b7e44246",
"text": "Website",
"counts": 0,
"total_count": 14,
"action_stream_count": 0,
"team_counts": [
{
"user_id": "5a6b0bf7aa7620bd07dfdd54",
"counts": 0
},
{
"user_id": "5a8432c8aa7620589026b730",
"counts": 0
},
{
"user_id": "5a93dc57aa762089fa2b0f01",
"counts": 13
},
{
"user_id": "5a93e279aa76202ba5311150",
"counts": 0
},
{
"user_id": "5a994f8daa7620e9aa3734fc",
"counts": 1
}
]
},
{
"id": "word_of_mouth",
"text": "Word of mouth",
"counts": 0,
"total_count": 0,
"action_stream_count": 0,
"team_counts": [
{
"user_id": "5a6b0bf7aa7620bd07dfdd54",
"counts": 0
},
{
"user_id": "5a8432c8aa7620589026b730",
"counts": 0
},
{
"user_id": "5a93dc57aa762089fa2b0f01",
"counts": 0
},
{
"user_id": "5a93e279aa76202ba5311150",
"counts": 0
},
{
"user_id": "5a994f8daa7620e9aa3734fc",
"counts": 0
}
]
}
],
"statuses": [
{
"status": {
"id": "5a6b0c0aaa7620bd07dfe0d8",
"status": "lead",
"text": "TruckFix Client",
"description": "Workshop Work",
"color": "f96600",
"counts": 2,
"total_count": 90,
"action_stream_count": 2,
"team_counts": [
{
"user_id": "5a6b0bf7aa7620bd07dfdd54",
"counts": 8
},
{
"user_id": "5a8432c8aa7620589026b730",
"counts": 2
},
{
"user_id": "5a93dc57aa762089fa2b0f01",
"counts": 12
},
{
"user_id": "5a93e279aa76202ba5311150",
"counts": 0
},
{
"user_id": "5a994f8daa7620e9aa3734fc",
"counts": 68
}
]
}
},
{
"status": {
"id": "5a6b0c0aaa7620bd07dfe0d9",
"status": "prospect",
"text": "ATN - Buyer",
"description": "Purchasing of Stock",
"color": "cc0000",
"counts": 0,
"total_count": 1826,
"action_stream_count": 0,
"team_counts": [
{
"user_id": "5a6b0bf7aa7620bd07dfdd54",
"counts": 2
},
{
"user_id": "5a8432c8aa7620589026b730",
"counts": 0
},
{
"user_id": "5a93dc57aa762089fa2b0f01",
"counts": 1824
},
{
"user_id": "5a93e279aa76202ba5311150",
"counts": 0
},
{
"user_id": "5a994f8daa7620e9aa3734fc",
"counts": 0
}
]
}
},
{
"status": {
"id": "5a6b0c0aaa7620bd07dfe0da",
"status": "customer",
"text": "ATN - Seller",
"description": "Selling of Stock",
"color": "3399ff",
"counts": 0,
"total_count": 0,
"action_stream_count": 0,
"team_counts": [
{
"user_id": "5a6b0bf7aa7620bd07dfdd54",
"counts": 0
},
{
"user_id": "5a8432c8aa7620589026b730",
"counts": 0
},
{
"user_id": "5a93dc57aa762089fa2b0f01",
"counts": 0
},
{
"user_id": "5a93e279aa76202ba5311150",
"counts": 0
},
{
"user_id": "5a994f8daa7620e9aa3734fc",
"counts": 0
}
]
}
},
{
"status": {
"id": "5a6b0c0aaa7620bd07dfe0db",
"status": "inactive",
"text": "ATN - Supplier",
"description": "Supplier to ATN",
"color": "009900",
"counts": 0,
"total_count": 652,
"action_stream_count": 0,
"team_counts": [
{
"user_id": "5a6b0bf7aa7620bd07dfdd54",
"counts": 651
},
{
"user_id": "5a8432c8aa7620589026b730",
"counts": 0
},
{
"user_id": "5a93dc57aa762089fa2b0f01",
"counts": 0
},
{
"user_id": "5a93e279aa76202ba5311150",
"counts": 0
},
{
"user_id": "5a994f8daa7620e9aa3734fc",
"counts": 1
}
]
}
},
{
"status": {
"id": "5a6b0c0aaa7620bd07dfe0dc",
"status": "general",
"text": "TruckFix Supplier",
"description": "Supplier to TruckFix",
"color": "000000",
"counts": 0,
"total_count": 144,
"action_stream_count": 0,
"team_counts": [
{
"user_id": "5a6b0bf7aa7620bd07dfdd54",
"counts": 0
},
{
"user_id": "5a8432c8aa7620589026b730",
"counts": 0
},
{
"user_id": "5a93dc57aa762089fa2b0f01",
"counts": 0
},
{
"user_id": "5a93e279aa76202ba5311150",
"counts": 0
},
{
"user_id": "5a994f8daa7620e9aa3734fc",
"counts": 144
}
]
}
},
{
"status": {
"id": "5a843c97aa76201c7929ec20",
"status": "custom1",
"text": "Prospect",
"description": "Potential Customer",
"color": "f96600",
"counts": 0,
"total_count": 1,
"action_stream_count": 0,
"team_counts": [
{
"user_id": "5a6b0bf7aa7620bd07dfdd54",
"counts": 1
},
{
"user_id": "5a8432c8aa7620589026b730",
"counts": 0
},
{
"user_id": "5a93dc57aa762089fa2b0f01",
"counts": 0
},
{
"user_id": "5a93e279aa76202ba5311150",
"counts": 0
},
{
"user_id": "5a994f8daa7620e9aa3734fc",
"counts": 0
}
]
}
}
],
"tags": {
"tags": [
{
"name": "ATN - Buyer",
"counts": 0,
"total_count": 1829,
"action_stream_count": 0
},
{
"name": "ATN - Seller",
"counts": 0,
"total_count": 3,
"action_stream_count": 0
},
{
"name": "ATN - Supplier",
"counts": 0,
"total_count": 740,
"action_stream_count": 0
},
{
"name": "Testing",
"counts": 0,
"total_count": 0,
"action_stream_count": 0
},
{
"name": "TruckFix - Client",
"counts": 2,
"total_count": 92,
"action_stream_count": 2
},
{
"name": "TruckFix - Supplier",
"counts": 0,
"total_count": 160,
"action_stream_count": 0
}
],
"system_tags": [
{
"name": "starred",
"counts": 0,
"total_count": 0,
"action_stream_count": 0
}
]
},
"contacts_count": {
"all": {
"1": 1,
"a": 102,
"b": 164,
"c": 154,
"d": 173,
"e": 66,
"f": 63,
"g": 111,
"h": 92,
"i": 36,
"j": 88,
"k": 109,
"l": 104,
"m": 402,
"n": 117,
"o": 33,
"p": 126,
"q": 5,
"r": 88,
"s": 272,
"t": 114,
"u": 8,
"v": 174,
"w": 68,
"x": 6,
"y": 6,
"z": 31,
"total_count": 2713
},
"users": [
{
"1": 0,
"a": 36,
"b": 43,
"c": 44,
"d": 37,
"e": 26,
"f": 19,
"g": 27,
"h": 23,
"i": 15,
"j": 25,
"k": 8,
"l": 24,
"m": 71,
"n": 14,
"o": 6,
"p": 35,
"q": 3,
"r": 31,
"s": 68,
"t": 36,
"u": 4,
"v": 35,
"w": 20,
"x": 3,
"y": 3,
"z": 6,
"total_count": 662,
"user_id": "5a6b0bf7aa7620bd07dfdd54"
},
{
"1": 0,
"a": 0,
"b": 1,
"c": 0,
"d": 0,
"e": 0,
"f": 0,
"g": 1,
"h": 0,
"i": 0,
"j": 0,
"k": 0,
"l": 0,
"m": 0,
"n": 0,
"o": 0,
"p": 0,
"q": 0,
"r": 0,
"s": 0,
"t": 0,
"u": 0,
"v": 0,
"w": 0,
"x": 0,
"y": 0,
"z": 0,
"total_count": 2,
"user_id": "5a8432c8aa7620589026b730"
},
{
"1": 1,
"a": 56,
"b": 115,
"c": 95,
"d": 121,
"e": 32,
"f": 33,
"g": 75,
"h": 65,
"i": 17,
"j": 55,
"k": 92,
"l": 72,
"m": 313,
"n": 99,
"o": 23,
"p": 86,
"q": 2,
"r": 50,
"s": 159,
"t": 67,
"u": 4,
"v": 131,
"w": 43,
"x": 3,
"y": 3,
"z": 24,
"total_count": 1836,
"user_id": "5a93dc57aa762089fa2b0f01"
},
{
"1": 0,
"a": 0,
"b": 0,
"c": 0,
"d": 0,
"e": 0,
"f": 0,
"g": 0,
"h": 0,
"i": 0,
"j": 0,
"k": 0,
"l": 0,
"m": 0,
"n": 0,
"o": 0,
"p": 0,
"q": 0,
"r": 0,
"s": 0,
"t": 0,
"u": 0,
"v": 0,
"w": 0,
"x": 0,
"y": 0,
"z": 0,
"total_count": 0,
"user_id": "5a93e279aa76202ba5311150"
},
{
"1": 0,
"a": 10,
"b": 5,
"c": 15,
"d": 15,
"e": 8,
"f": 11,
"g": 8,
"h": 4,
"i": 4,
"j": 8,
"k": 9,
"l": 8,
"m": 18,
"n": 4,
"o": 4,
"p": 5,
"q": 0,
"r": 7,
"s": 45,
"t": 11,
"u": 0,
"v": 8,
"w": 5,
"x": 0,
"y": 0,
"z": 1,
"total_count": 213,
"user_id": "5a994f8daa7620e9aa3734fc"
}
]
},
"team_stream": {
"users": [
{
"user_id": "5a6b0bf7aa7620bd07dfdd54",
"counts": 663
},
{
"user_id": "5a8432c8aa7620589026b730",
"counts": 2
},
{
"user_id": "5a93dc57aa762089fa2b0f01",
"counts": 1836
},
{
"user_id": "5a93e279aa76202ba5311150",
"counts": 0
},
{
"user_id": "5a994f8daa7620e9aa3734fc",
"counts": 214
}
],
"all": 2715
}
}

Any insights you might be able to offer would be most helpful. Thanks!

kevin at June 25th, 2018 05:19 — #4

Hi FrankEBailey,

Thank you for the extra information. The response you posted is the response you should see when your search criteria doesn't match any of your contacts.

Are you the owner of the contacts that you expect to be returned? If not, can you try the following in order to include contacts not owned by you?

https://app.onepagecrm.com/api/v3/contacts.json?search=abacus&team=true

Failing this, could you post a sample output of

https://app.onepagecrm.com/api/v3/companies?name=abacus

Thank you,

Kevin

frankebailey at June 25th, 2018 05:49 — #5

Hi Kevin,

Thanks for the info - the "team" parameter did the trick here. I can now see both the Abacus companies in the results. I've discovered that I can also specify a tag that the result must have, in order to get the correct one of the two companies.

Is there a way to prevent the returned data from including all the additional settings like lead sources, tags etc?

kevin at June 25th, 2018 06:06 — #6

Hi FrankEBailey,

Glad that worked.

It currently isn't possible to filter the extra response fields. I will bring this up with the team today to see if there is support for adding this feature in the future.

Thank you for your suggestion,

Kevin

frankebailey at June 25th, 2018 06:19 — #7

Thanks Kevin.

It's no real issue that the extra info comes along with the response, I'm just old school and try to limit unnecessary web traffic as much as possible.