Get mapping history for an agent

GET

/agents/:phoneNumber/mappings/mongo

GET

/agents/:phoneNumber/mappings/mongo

$ curl https://api.messageblue.ai/agents/phoneNumber/mappings/mongo \
>      -H "X-App-Id: <apiKey>" \
>      -H "Content-Type: application/json"

1 {
2   "ok": true,
3   "data": {
4     "agent": {
5       "id": "agent-12345",
6       "lastSeen": "2024-04-20T14:22:00Z",
7       "name": "MacBook Pro Agent",
8       "status": "active"
9     },
10     "totalMappings": 3,
11     "includeDeleted": true,
12     "mappings": [
13       {
14         "accountId": "acc-987654321",
15         "userNumber": "+14155552671",
16         "agentNumber": "+14155559876",
17         "createdAt": "2024-01-15T09:30:00Z",
18         "lastUpdatedAt": "2024-04-10T11:45:00Z",
19         "outbound": 125,
20         "inbound": 98,
21         "lastRespondedAt": "2024-04-19T16:00:00Z",
22         "lastReceivedAt": "2024-04-19T15:55:00Z",
23         "deleted": true,
24         "deletedAt": "2024-04-01T08:00:00Z"
25       }
26     ]
27   },
28   "meta": {
29     "requestId": "550e8400-e29b-41d4-a716-446655440000",
30     "timestamp": "2026-07-10T06:00:00.000Z"
31   }
32 }

Retrieves the persistent mapping records for an agent, including soft-deleted entries when includeDeleted=true.

Authentication

X-App-Idstring

Your MessageBlue App ID, sent in clear on every request. It is paired with request signing: each request is also signed with your App Secret (see the Authentication tag). The App Secret itself is NEVER transmitted — it is only the HMAC signing key.

Path parameters

phoneNumberstringRequired

Query parameters

includeDeletedenumOptional

Allowed values:

Response

okboolean

dataobject

Endpoint-specific payload wrapped in a standard success envelope.

metaobject

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error