Numeracle API’s is a reliable and efficient solution for organizations seeking to harness the power of phone number related information.
\nNumeracle employs OAuth 2.0 for authentication. To execute the API, you’ll require a bearer
token. Generate this token using the provided Client ID and secret. Below is an
example of how to create the bearer token.
curl -X POST https://www.sandbox.numeracle.com/oauth/token \\
\n-H \"Content-Type: application/x-www-form-urlencoded\" \\
\n-u : \\<**YOUR_CLIENT_ID**>:<**YOUR_CLIENT_SECRET**>\\
\n-d \"grant_type=client_credentials”
\nRemember to replace YOUR_CLIENT_ID and YOUR_CLIENT_SECRET with your actual credentials.
\nNote: The validity of bearer token is around 9 hrs approx. , If you encounter an unauthorized error,please generate a new token with client ID and client secret.
\nhttps://www.sandbox.numeracle.com
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Why Choose Numeracle API's:","slug":"why-choose-numeracle-apis"}],"owner":"39598180","collectionId":"d194bb3b-6d4f-4151-bab0-6c02946bc9aa","publishedId":"2sBYHRTgG2","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-10-12T04:00:18.000Z"},"item":[{"name":"oauth","item":[{"name":"token","item":[{"name":"Sandbox Token","id":"80e6fac6-7ed5-47d6-9493-84be2ad374c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Note: The validity of the bearer token is around 9 hours.
If you encounter an unauthorized error, please generate a new token with the client ID and client secret.
Smart Branding Summary Metrics API
\nOverview
\nReturns aggregated Smart Branding metrics for the given filters and date range (max 13 months).
\nRequest Body:
\nResponse Parameter:
\nInput Validations:
\nBusiness Validations:
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Smart Branding Details Metrics API
\nOverview
\nReturns paginated Smart Branding detailed metrics for the given filters and date range. Maximum date range is 60 days. Supports optional filters by brand, number profile, providers, and up to 50 phone numbers (E.164).
\nRequest: POST with JSON body; optional query parameters for pagination.
\nQuery parameters:
\nRequest body
\nResponse parameters (200 OK)
\nInput validations
\nBusiness validations
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Smart Branding Data Status API
\nOverview
\nReturns current data availability status across all providers for the specified root entity. Use to see last update timestamps, data-through dates, and next expected update per provider.
\nRequest (GET, query parameters):
\nResponse parameters (200 OK)
\nInput validations
\nBusiness validations
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Smart Branding Entities API
\nOverview
\nReturns a paginated list of Smart Branding entities (and optionally their profiles/campaigns) for a given root entity. Supports incremental dump via lastUpdatedTimestamp, entity‑level access control, and HATEOAS links for navigation.
\nRequest Parameters:
\nResponse Body:
\nInput Validations:
\nBusiness Validations
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"CDR Smart Branding OOB Metrics API
\nOverview
\nRetrieves Call Detail Records (CDR) for Smart Branding out-of-band (OOB) metrics for a given root entity, filtered by a last updated timestamp. Supports pagination.
\nRequest: GET with query parameters; no request body.
\nQuery parameters:
\nResponse parameters (200 OK)
\nInput validations
\nBusiness validations
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Providers Smart Branding OOB Metrics API
\nOverview
\nReturns the list of supported providers for Smart Branding out-of-box (OOB) metrics.
\nRequest: GET with no query parameters and no request body.
\nQuery parameters:
\nThis endpoint does not accept any query parameters.
\nResponse parameters (200 OK)
\nBusiness validations
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Disable Smart Branding Campaign
This method is used to disable a Smart Branding Campaign.
Path Parameters:
\nResponse Parameters:
\nInput Validations:
\nBusiness Validations:
\n","urlObject":{"protocol":"https","path":["api","v1","branded-calls","NUMEXXXXXXXXXXX-XXXXXXXXXXXX"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"9107c0f1-811f-4196-a564-fa6bbe3abb6f","name":"200-OK","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"BearerView Smart Branding Campaign
This method is used to view a Smart Branding Campaign.
Path Parameters:
\nResopnse Parameters:
\nInput Validations:
\nBusiness Validations:
\n","urlObject":{"protocol":"https","path":["api","v1","branded-calls","{workOrderId}"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"de86c192-c583-441a-87d6-96e92c4b523f","name":"200-OK","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"BearerUpdate Smart Branding CampaignThis method is used to update a Smart Branding Campaign.It allows for adding or removing NumberProfileIDs. Additionally, it provides functionality to enable or disable services associated with the campaign.
\nPath Parameter:
\nRequest Parameter:
\nResponse Parameter:
\nInput Validations:
\nBusiness Validations:
\n","urlObject":{"protocol":"https","path":["api","v1","branded-calls","NUMEXXXXXXXXXXX-XXXXXXXXXXXX"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"baf003ca-b0e7-4455-9e73-322e47c92d6b","name":"200-OK","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"BearerCreate Smart Branding Campaign
\nThis method is used to create a new number Smart Branding Campaign.
\nA minimum 30-day interval between dates is required. Before activating the AT&T service, documentation must be submitted to the Numeracle team. At least one of the services—tMobile, att, or verizon—must be enabled.
\nRequest Parameters:
\nResponse Parameters:
\nInput Validations:
\nBusiness Validaions:
\n","urlObject":{"protocol":"https","path":["api","v1","branded-calls"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"51a5ae7c-b5d8-41e6-aab3-fde7dded6c5c","name":"201-Created","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"BearerCreate Smart Branding Campaign
\nThis method is used to create a new number Smart Branding Campaign.
\nA minimum 30-day interval between dates is required. Before activating the AT&T service, documentation must be submitted to the Numeracle team. At least one of the services—tMobile, att, or verizon—must be enabled.
\nView Smart Branding Campaign
\nThis method is used to view a Smart Branding Campaign.
\nDisable Smart Branding Campaign
\nThis method is used to disable a Smart Branding Campaign.
\nUpdate Smart Branding Campaign
\nThis method is used to update a Smart Branding Campaign.It allows for adding or removing NumberProfileIDs. Additionally, it provides functionality to enable or disable services associated with the campaign.
\n","_postman_id":"53251366-5a56-4329-9907-e27c4f41f97a","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Smart branding refers to the strategic use of branding techniques and technologies to enhance customer engagement, optimize brand perception, and achieve competitive advantage. Here are key aspects of smart branding.
\nSmart branding goes beyond traditional branding methods by leveraging technology, data, and personalized strategies to create meaningful connections with customers and drive business growth. It aims to create a distinctive brand identity that resonates with consumers and positions the brand competitively in the marketplace.
\n","_postman_id":"efd98ab7-3216-4432-b639-b6b6ee123e07","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"