List

{ "name" "list all contacts", "method" "get", "url" "https //data successeve com/v2/contacts", "description" "a pageable list of contacts the contact list contains a pagination object that indicates if more contacts exist via the next field, whose value is a url that can be used to fetch the next page if the next field is not present, that indicates there are no further contacts in the list ", "tab" "examples", "examples" { "languages" \[ { "id" "ul9y6vkzmwn5hu ri7qyf", "language" "curl", "code" "\ncurl x get https //data successeve com/v2/contacts \\\\\n h 'accept application/json'\n h 'authorization\ bearer \<your access token>'", "customlabel" "" } ], "selectedlanguageid" "ul9y6vkzmwn5hu ri7qyf" }, "results" { "languages" \[ { "id" "bskp nwjbyicuxl8qk8ha", "language" "200", "customlabel" "", "code" "{\n \\"object\\" \\"contact list\\",\n \\"data\\" \[\n {\n \\"object\\" \\"contact\\",\n \\"id\\" \\"5d3bae5bcb4a287b44583a55\\",\n \\"unique id\\" \\"5d3bae4cf92ea13a3dfb542e\\",\n \\"created at\\" 1564192347,\n \\"data\\" {\n \n },\n \\"salesmachine\\" {\n \n },\n \\"stage\\" {\n \\"name\\" \\"trial\\",\n \\"id\\" \\"5b2bc014ce8d8355c6d48b70\\"\n },\n \\"accounts\\" {\n \\"object\\" \\"account list\\",\n \\"data\\" \[\n {\n \\"id\\" \\"5d3bae278cae234bef95405a\\"\n }\n ]\n }\n }\n ],\n \\"pagination\\" {\n \\"total\\" 4019,\n \\"offset\\" 0,\n \\"limit\\" 25,\n \\"count\\" 25,\n \\"next\\" \\"https //data successeve com/v2/contacts?offset=25\&limit=25\\"\n }\n}\n" }, { "id" "jvybkuagocpkpth1xaqmq", "language" "404", "customlabel" "", "code" "{\n \\"message\\" \\"object not found \\"\n }" } ], "selectedlanguageid" "bskp nwjbyicuxl8qk8ha" }, "request" { "pathparameters" \[], "queryparameters" \[ { "name" "status", "kind" "optional", "type" "string", "description" "possible values are 'trial', 'paying', 'churned' or 'not converted' ", "children" \[] }, { "name" "archived", "kind" "optional", "type" "boolean", "description" "if true only archived contacts are listed", "children" \[] }, { "name" "offset", "kind" "optional", "type" "number", "description" "what offset of results to fetch ", "children" \[] }, { "name" "limit", "kind" "optional", "type" "number", "description" "how many results per page defaults 25, max is 100 ", "children" \[] }, { "name" "order", "kind" "optional", "type" "string", "description" "returns the contacts in ascending or descending order \nvalid values 'asc' or 'desc' default to 'desc'", "children" \[] }, { "name" "sort", "kind" "optional", "type" "string", "description" "what field to sort the results by valid value 'created at'", "children" \[] } ], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "query parameter", "value" "queryparameters" } }