List Customers

2 min

{ "name" "show all customers the requesting manager has access permissions to ", "method" "get", "url" " /api/v1/customers/", "description" "", "tab" "examples", "examples" { "languages" \[ { "id" "x imbdhssfczdzyzr969f", "language" "json", "code" "{\n \\"count\\" 9,\n \\"next\\" null,\n \\"previous\\" null,\n \\"results\\" \[\n {\n \\"id\\" 620,\n \\"total orders\\" 52,\n \\"total licenses\\" 117,\n \\"labels\\" \[\n {\n \\"id\\" 3,\n \\"label id\\" 8,\n \\"label\\" \\"customer\\",\n \\"color\\" \\"#ff9f43\\"\n },\n {\n \\"id\\" 53,\n \\"label id\\" 34,\n \\"label\\" \\"loyal\\",\n \\"color\\" \\"#3a0cd4\\"\n }\n ],\n \\"customer account\\" null,\n \\"email\\" \\"tc\@tc com\\",\n \\"first name\\" \\"nameo\\",\n \\"last name\\" \\"\\",\n \\"company name\\" \\"\\",\n \\"phone\\" \\"\\",\n \\"reference\\" \\"\\",\n \\"address\\" \\"\\",\n \\"postcode\\" \\"\\",\n \\"city\\" \\"\\",\n \\"country\\" \\"\\",\n \\"state\\" \\"\\",\n \\"clabels all\\" \\"customerloyal\\",\n \\"cognito user pool id\\" \\"\\",\n \\"metadata\\" {},\n \\"company\\" 277,\n \\"license user\\" 1879,\n \\"clabels\\" \[\n 8,\n 34\n ]\n },\n \n ]\n}", "customlabel" "" } ], "selectedlanguageid" "x imbdhssfczdzyzr969f" }, "results" { "languages" \[ { "id" "amxhpvtczrknoilqyp kz", "language" "200", "code" "code 200 ok", "customlabel" "" }, { "id" "eapheg84r4hgunxopgq4p", "language" "404", "code" "{\n \\"message\\" \\"ain't no cake like that \\"\n}", "customlabel" "" } ], "selectedlanguageid" "amxhpvtczrknoilqyp kz" }, "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" }, "hastryitout" false } query parameters pagination default pagination is 20 results per page limit number of results to return per page example limit=20 offset the initial index from which to return the results example offset=21 filtering the results can be filtered by various attributes on customer or related to the customer possible filters label in email email icontains email startswith company name icontains first name icontains last name icontains phone icontains reference reference icontains reference startswith account account name account name icontains account code account code icontains account description account description icontains account phone account phone icontains account address account address icontains account email account email icontains account reference account reference icontains metadata