> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.messageblue.ai/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.messageblue.ai/_mcp/server. # Get all mappings for an agent GET https://api.messageblue.ai/agents/{phoneNumber}/mappings Returns the full list of user-number mappings currently assigned to the specified agent. Reference: https://docs.messageblue.ai/api-reference/agents/get-agent-mappings ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: swagger version: 1.0.0 paths: /agents/{phoneNumber}/mappings: get: operationId: getAgentMappings summary: Get all mappings for an agent description: >- Returns the full list of user-number mappings currently assigned to the specified agent. tags: - agents parameters: - name: phoneNumber in: path required: true schema: type: string - name: X-App-Id in: header description: >- 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. required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AgentMappingsResponse' '400': description: Invalid phone number format content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Agent not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' servers: - url: https://api.messageblue.ai description: Production - url: http://localhost:8080 description: Local development components: schemas: AgentMapping: type: object properties: accountId: type: string userNumber: type: string agentNumber: type: string createdAt: type: - number - 'null' format: double outbound: type: number format: double inbound: type: number format: double lastRespondedAt: type: - number - 'null' format: double lastReceivedAt: type: - number - 'null' format: double title: AgentMapping AgentMappingsResponseData: type: object properties: agent: type: object additionalProperties: description: Any type mappings: type: array items: $ref: '#/components/schemas/AgentMapping' description: Endpoint-specific payload wrapped in a standard success envelope. title: AgentMappingsResponseData ResponseMeta: type: object properties: requestId: type: string format: uuid timestamp: type: string format: date-time required: - requestId - timestamp title: ResponseMeta AgentMappingsResponse: type: object properties: ok: type: boolean data: $ref: '#/components/schemas/AgentMappingsResponseData' description: Endpoint-specific payload wrapped in a standard success envelope. meta: $ref: '#/components/schemas/ResponseMeta' required: - ok - data - meta title: AgentMappingsResponse FieldError: type: object properties: field: type: string issue: type: string message: type: string required: - field - issue - message title: FieldError ErrorResponseErrorDetails0: type: array items: $ref: '#/components/schemas/FieldError' title: ErrorResponseErrorDetails0 ErrorResponseErrorDetails: oneOf: - $ref: '#/components/schemas/ErrorResponseErrorDetails0' - type: object additionalProperties: description: Any type description: Field validation errors (array) or domain-specific context (object). title: ErrorResponseErrorDetails ErrorResponseError: type: object properties: code: type: string message: type: string requestId: type: string format: uuid details: $ref: '#/components/schemas/ErrorResponseErrorDetails' description: Field validation errors (array) or domain-specific context (object). required: - code - message - requestId title: ErrorResponseError ErrorResponse: type: object properties: ok: type: boolean error: $ref: '#/components/schemas/ErrorResponseError' required: - ok - error title: ErrorResponse securitySchemes: appId: type: apiKey in: header name: X-App-Id description: >- 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. ``` ## Examples **Request** ```json {} ``` **Response** ```json { "ok": true, "data": { "agent": { "id": "agent-12345", "name": "MacBook Pro Agent", "phoneNumber": "+14155552671", "status": "active" }, "mappings": [ { "accountId": "acc-987654321", "userNumber": "+14155550123", "agentNumber": "+14155552671", "createdAt": 1689004800, "outbound": 152, "inbound": 134, "lastRespondedAt": 1689590400, "lastReceivedAt": 1689586800 } ] }, "meta": { "requestId": "550e8400-e29b-41d4-a716-446655440000", "timestamp": "2026-07-10T06:00:00.000Z" } } ``` **SDK Code** ```python import requests url = "https://api.messageblue.ai/agents/phoneNumber/mappings" payload = {} headers = { "X-App-Id": "", "Content-Type": "application/json" } response = requests.get(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.messageblue.ai/agents/phoneNumber/mappings'; const options = { method: 'GET', headers: {'X-App-Id': '', 'Content-Type': 'application/json'}, body: '{}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.messageblue.ai/agents/phoneNumber/mappings" payload := strings.NewReader("{}") req, _ := http.NewRequest("GET", url, payload) req.Header.Add("X-App-Id", "") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.messageblue.ai/agents/phoneNumber/mappings") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["X-App-Id"] = '' request["Content-Type"] = 'application/json' request.body = "{}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.messageblue.ai/agents/phoneNumber/mappings") .header("X-App-Id", "") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php request('GET', 'https://api.messageblue.ai/agents/phoneNumber/mappings', [ 'body' => '{}', 'headers' => [ 'Content-Type' => 'application/json', 'X-App-Id' => '', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.messageblue.ai/agents/phoneNumber/mappings"); var request = new RestRequest(Method.GET); request.AddHeader("X-App-Id", ""); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "X-App-Id": "", "Content-Type": "application/json" ] let parameters = [] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.messageblue.ai/agents/phoneNumber/mappings")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers request.httpBody = postData as Data 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() ```