List resources for an end user, optionally filtered by provider

curl --request GET \
  --url https://api.routemcp.io/api/v1/crm/{resource} \
  --header 'Authorization: <api-key>' \
  --header 'X-End-User-Id: <x-end-user-id>'

import requests

url = "https://api.routemcp.io/api/v1/crm/{resource}"

headers = {
    "X-End-User-Id": "<x-end-user-id>",
    "Authorization": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-End-User-Id': '<x-end-user-id>', Authorization: '<api-key>'}
};

fetch('https://api.routemcp.io/api/v1/crm/{resource}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.routemcp.io/api/v1/crm/{resource}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "X-End-User-Id: <x-end-user-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.routemcp.io/api/v1/crm/{resource}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-End-User-Id", "<x-end-user-id>")
	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.routemcp.io/api/v1/crm/{resource}")
  .header("X-End-User-Id", "<x-end-user-id>")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.routemcp.io/api/v1/crm/{resource}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-End-User-Id"] = '<x-end-user-id>'
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "statusCode": 200,
  "message": "OK",
  "data": [
    {
      "id": "12345",
      "remote_id": "12345",
      "first_name": "Jane",
      "last_name": "Doe",
      "email": "jane.doe@example.com",
      "phone": "+1-555-0100",
      "job_title": "VP of Sales",
      "address": {
        "street_1": "123 Main St",
        "city": "San Francisco",
        "state": "CA",
        "postal_code": "94105",
        "country": "US"
      },
      "lifecycle_stage": "customer",
      "owner": "67823451",
      "owner_name": "John Smith",
      "owner_email": "john.smith@acme.com",
      "source": null,
      "remote_created_at": "2025-01-15T10:00:00.000Z",
      "remote_updated_at": "2025-03-01T14:30:00.000Z",
      "providerSlug": "hubspot",
      "providerId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    }
  ],
  "pagination": {
    "cursor": null,
    "hasMore": false,
    "limit": 25
  }
}

GET

crm

{resource}

List resources for an end user, optionally filtered by provider

curl --request GET \
  --url https://api.routemcp.io/api/v1/crm/{resource} \
  --header 'Authorization: <api-key>' \
  --header 'X-End-User-Id: <x-end-user-id>'

import requests

url = "https://api.routemcp.io/api/v1/crm/{resource}"

headers = {
    "X-End-User-Id": "<x-end-user-id>",
    "Authorization": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-End-User-Id': '<x-end-user-id>', Authorization: '<api-key>'}
};

fetch('https://api.routemcp.io/api/v1/crm/{resource}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.routemcp.io/api/v1/crm/{resource}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "X-End-User-Id: <x-end-user-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.routemcp.io/api/v1/crm/{resource}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-End-User-Id", "<x-end-user-id>")
	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.routemcp.io/api/v1/crm/{resource}")
  .header("X-End-User-Id", "<x-end-user-id>")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.routemcp.io/api/v1/crm/{resource}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-End-User-Id"] = '<x-end-user-id>'
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "statusCode": 200,
  "message": "OK",
  "data": [
    {
      "id": "12345",
      "remote_id": "12345",
      "first_name": "Jane",
      "last_name": "Doe",
      "email": "jane.doe@example.com",
      "phone": "+1-555-0100",
      "job_title": "VP of Sales",
      "address": {
        "street_1": "123 Main St",
        "city": "San Francisco",
        "state": "CA",
        "postal_code": "94105",
        "country": "US"
      },
      "lifecycle_stage": "customer",
      "owner": "67823451",
      "owner_name": "John Smith",
      "owner_email": "john.smith@acme.com",
      "source": null,
      "remote_created_at": "2025-01-15T10:00:00.000Z",
      "remote_updated_at": "2025-03-01T14:30:00.000Z",
      "providerSlug": "hubspot",
      "providerId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    }
  ],
  "pagination": {
    "cursor": null,
    "hasMore": false,
    "limit": 25
  }
}

Authorizations

Authorization

string

header

required

Enter your API key with the Bearer prefix — e.g. Bearer sk_live_xxx (production) or Bearer sk_test_xxx (sandbox)

Headers

X-End-User-Id

string

required

Identifier of the end user whose connected provider should be queried. This is the same endUserId you supplied when creating the connect token. Required on every CRM and accounting call.

Example:

"user-001"

Path Parameters

resource

enum<string>

required

Canonical CRM resource type to query. Must be one of the values in the enum below. RouteMCP maps this to the equivalent provider-native object (e.g. contact → HubSpot Contacts, Pipedrive Persons, Zoho Contacts).

Available options:

contact,

lead,

deal,

meeting,

owner,

company,

note,

task,

pipeline,

activity,

appointment

Query Parameters

provider

string

Provider slug to scope the query to a single connected provider (e.g. hubspot, pipedrive, zoho-crm, quickbooks-online, xero, zoho-books). When omitted, RouteMCP fans out across every provider the end user has connected and returns a merged, paginated result.

Example:

"hubspot"

cursor

string

Opaque pagination cursor returned in the previous response's top-level pagination.cursor field. Pass it back unchanged to fetch the next page. Omit on the first request.

Example:

"eyJodWJzcG90IjoiMTAwIn0"

limit

string

Maximum number of records to return per page. Defaults to the provider's native page size (typically 25–100) when omitted. Values are clamped to each provider's supported maximum.

Example:

"25"

enrich

string

Controls enrichment of related-record fields such as owner_name, owner_email, contact_name, companyName, etc. Accepts:

true (default) — enrich all supported fields. Adds extra provider calls; slower but more complete.
false — skip enrichment entirely. Fastest; returns only ids for related records.
A comma-separated list of field names (e.g. owner_name,owner_email) — enrich only the listed fields.

Example:

"true"

Response

Paginated list of CRM resources

Standard envelope returned by GET /crm/{resource}. The shape of each item inside data depends on the {resource} path parameter — see the tabs to switch between resource variants.

success

boolean

required

Always true for successful (2xx) responses.

Example:

true

statusCode

integer

required

HTTP status code mirrored inside the envelope.

Example:

200

message

string

required

Example:

"OK"

data

required

The list of CRM resources. The item shape depends on the {resource} path parameter.

A person record (typically associated with a company/account).

Show child attributes

pagination

Pagination · object

required

Cursor-based pagination metadata returned with every list response.

Show child attributes

API Reference Get available appointment slots

Overview

CRM Resources

Workspaces

HTTP Streaming Chat

Accounting Resources

Field Mappings

Connect

List resources for an end user, optionally filtered by provider

Authorizations

Headers

Path Parameters

Query Parameters

Response