> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://api.docs.modulards.com/modular-ds-public-api/contacts/manage-contacts/list-contacts/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://api.docs.modulards.com/_mcp/server. # List contacts GET https://api.modulards.com/api/public/v1/contacts Lists the contacts you can reach. Use it to find a recipient by name or company, or to check who already has an email or a WhatsApp number before adding them to a notification configuration. By default contacts come sorted by name. Add each contact's contact methods to the answer with `include`. Reference: https://api.docs.modulards.com/modular-ds-public-api/contacts/manage-contacts/list-contacts ## Authentication - `Authorization` header (bearer token, required) — Personal access token created in the Modular DS dashboard; read-only tokens can only call GET endpoints. ## Request ### Query parameters - `page[number]` (string, optional) — Page number, starting at 1. - `page[size]` (string, optional) — Rows per page, up to 50 (default 15). - `sort` (string, optional) — Sort order. Accepted: `name`, `last_name`, `company`, `created_at`; a leading `-` reverses the order. Default `name`, ascending. - `include` (string, optional) — Related data to return with each contact. Accepted: `contact_methods`. - `filter[id][]` (string, optional) — Only these contacts, by contact id. Several ids match any of them. - `filter[s]` (string, optional) — Free-text search over the name, the last name and the company. - `filter[channel]` (string, optional) — Only the contacts that have a contact method on this channel: `email` or `whatsapp`. ## Response ### 200 200 - Contacts - `data` (list of ApiPublicV1ContactsGetResponsesContentApplicationJsonSchemaDataItems, optional) - `jsonapi` (ApiPublicV1ContactsGetResponsesContentApplicationJsonSchemaJsonapi, optional) - `links` (ApiPublicV1ContactsGetResponsesContentApplicationJsonSchemaLinks, optional) - `meta` (ApiPublicV1ContactsGetResponsesContentApplicationJsonSchemaMeta, optional) ## Types ### ApiPublicV1ContactsGetResponsesContentApplicationJsonSchemaDataItems - `attributes` (ApiPublicV1ContactsGetResponsesContentApplicationJsonSchemaDataItemsAttributes, optional) - `id` (string, optional) - `links` (ApiPublicV1ContactsGetResponsesContentApplicationJsonSchemaDataItemsLinks, optional) - `type` (string, optional) ### ApiPublicV1ContactsGetResponsesContentApplicationJsonSchemaJsonapi - `version` (string, optional) ### ApiPublicV1ContactsGetResponsesContentApplicationJsonSchemaLinks - `first` (string, optional) - `last` (string, optional) - `next` (any, optional, nullable) - `prev` (any, optional, nullable) ### ApiPublicV1ContactsGetResponsesContentApplicationJsonSchemaMeta - `current_page` (double, optional) - `from` (double, optional) - `last_page` (double, optional) - `links` (list of ApiPublicV1ContactsGetResponsesContentApplicationJsonSchemaMetaLinksItems, optional) - `path` (string, optional) - `per_page` (double, optional) - `to` (double, optional) - `total` (double, optional) ### ApiPublicV1ContactsGetResponsesContentApplicationJsonSchemaDataItemsAttributes - `company` (any, optional, nullable) - `created_at` (string, optional) - `last_name` (string, optional) - `name` (string, optional) - `updated_at` (string, optional) ### ApiPublicV1ContactsGetResponsesContentApplicationJsonSchemaDataItemsLinks - `self` (string, optional) ### ApiPublicV1ContactsGetResponsesContentApplicationJsonSchemaMetaLinksItems - `active` (boolean, optional) - `label` (string, optional) - `url` (string, optional, nullable) ## Examples **Response** ```json { "data": [ { "attributes": { "company": null, "created_at": "2026-08-10T09:00:00.000000Z", "last_name": "Smith", "name": "Bob", "updated_at": "2026-08-10T09:00:00.000000Z" }, "id": "201", "links": { "self": "https://api.modulards.com/api/public/v1/contacts/201" }, "type": "contacts" } ], "jsonapi": { "version": "1.1" }, "links": { "first": "https://api.modulards.com/api/public/v1/contacts?page%5Bnumber%5D=1", "last": "https://api.modulards.com/api/public/v1/contacts?page%5Bnumber%5D=1", "next": null, "prev": null }, "meta": { "current_page": 1, "from": 1, "last_page": 1, "links": [ { "active": false, "label": "« Previous", "url": null }, { "active": true, "label": "1", "url": "https://api.modulards.com/api/public/v1/contacts?page%5Bnumber%5D=1" }, { "active": false, "label": "Next »", "url": null } ], "path": "https://api.modulards.com/api/public/v1/contacts", "per_page": 15, "to": 1, "total": 1 } } ``` **SDK Code** ```python 200 - Contacts import requests url = "https://api.modulards.com/api/public/v1/contacts" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript 200 - Contacts const url = 'https://api.modulards.com/api/public/v1/contacts'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go 200 - Contacts package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.modulards.com/api/public/v1/contacts" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby 200 - Contacts require 'uri' require 'net/http' url = URI("https://api.modulards.com/api/public/v1/contacts") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java 200 - Contacts import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.modulards.com/api/public/v1/contacts") .header("Authorization", "Bearer ") .asString(); ``` ```php 200 - Contacts request('GET', 'https://api.modulards.com/api/public/v1/contacts', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp 200 - Contacts using RestSharp; var client = new RestClient("https://api.modulards.com/api/public/v1/contacts"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift 200 - Contacts import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://api.modulards.com/api/public/v1/contacts")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```