Bright Pattern is a cloud contact center (CCaaS) software company whose omnichannel platform routes voice, IVR, email, chat, SMS/MMS, video and social messenger conversations to agents, with built-in quality management, workforce management, outbound dialing and AI/bot assistance. The platform is multi-tenant: every customer contact center runs on its own tenant hostname, and Bright Pattern exposes nine public REST API families against that tenant — Configuration, SCIM-compliant user provisioning, List Management (v2, v3.0, v3.2), Task Routing, SMS/MMS, Interaction Content (call recordings and metadata), Real-Time Statistics, and the Mobile/Web Messaging APIs (v1 and v2) that back the iOS and Android Mobile SDKs. The public API reference is published as Postman documenter collections linked from the Bright Pattern documentation wiki.
Bright Pattern publishes 14 API contracts indexed on the APIs.io network, including Authentication API, Calling List API, Campaigns API, and 11 more. Tagged areas include Company, Contact Center, CCaaS, Customer Experience, and Omnichannel.
The Bright Pattern catalog on APIs.io includes 1 Spectral governance ruleset.
Bright Pattern’s developer surface includes authentication, documentation, API reference, getting-started guide, support, engineering blog, pricing, and 30 more developer resources.
Regulatory Posture applies to this provider. Its tags matched the
Telecommunications regime, so
Regulatory Posture carries 15 points of the composite.
If this regime is wrong for your business, say so on your
provider repo — the
applicability map is public and we will correct it.
Create-or-Update Ergonomics applies to this provider. This API accepts writes, so it
carries 10 points of the composite. It is scored from the published contracts
themselves: whether a caller can create-or-update in one call, whether the write accepts a key the caller already
holds, and whether the response says which branch ran. Without that, every write needs a search-and-branch in
front of it, and the first time that check is skipped a duplicate record is created.
Scored against the observed mean rather than raw — a provider at the catalog average is unchanged by this facet,
not penalised by it.
The six quality facets above are damped to 75 points between them,
because the conditional facet above carries the other
25. That is why each facet's contribution is shown against a damped
maximum: raising a quality facet moves the composite by 75% of its nominal
weight, not 100%. The full arithmetic is at apis.io/rating/.
Show this score on your site.
It updates itself when the score changes. Paste this where you link to your API docs:
<a href="https://apis.io/providers/bright-pattern/"><img src="https://apis.io/badge/bright-pattern/card.svg" alt="Bright Pattern on APIs.io — Kin Score by API Evangelist"></a>
Other styles, a README pill and a shields.io endpoint are on the badge page.
Raise your score.
Agent readiness — checks not met, largest first (exact, from this profile):
MCP Server+12 pts — deployment.mode + probe verdict on the mcp/ manifest, not the pointer; an unprobed slug falls back to authorship
A2A Agent Card+8 pts — a2a/-a2a.yml manifest, graded on conformance.grade against A2A 1.0.0
Rate-Limit Signaling+7 pts — OpenAPI responses document X-RateLimit-* / RateLimit headers (verified), else a rate_limits artifact or RateLimits link (documented)
Delegated User Identity+6 pts — a served discovery document listing authorization_code in grant_types_supported (served), else an oauth2 authorizationCode flow or openIdConnect declared in an OpenAPI (documented)
Typed Event Surface+6 pts — AsyncAPI document, OR webhooks/callbacks objects in the as-published OpenAPI, OR common[].type includes Webhooks
6 more unmet checks in the Agent Readiness table above.
Kin Score — facets with the most composite points still available (weight × headroom):
The Kin Score Market layer reads a provider inside its market:
its position, and how deep its integrations go. Depth is only comparable within a position. Provisional and unweighted:
not part of the Kin Score or agent readiness.
Registered MCP server and declares compatibility are report only — not weighted.
Undeclared means we found nothing we can read, so there is no number: we never infer integrations.
Standards this provider implements or carries. De facto ones are profiled and measured by the API Commons; formal ones come from the standards directory and are linked by the provider's own tags. The evidence column says how each claim was established — not that it was made.
The OAuth 2.0 Client Credentials Grant is used to authenticate clients of this API. The authenticated user is checked for having appropriate privileges to perform the requested ...
Bright Pattern's List Management API makes it easy to manage the contents of Do Not Call (DNC) lists with bulk delete, add, and replace actions. The API methods described in thi...
Bright Pattern's List Management API provides the ability to manage Link Groups so several campaigns can be linked together. When processing all records of one campaign is finis...
Bright Pattern's List Management API streamlines the creation and deletion of lists and formats and provides a convenient way to manage list records. Note: Performing operations...
These methods are used to extract individual segments of multichannel call recordings (i.e., recordings where voice of each paricipating party is recorded into a separate audio ...
With the https://:tenant/configapi/v2/phone endpoint you can: Get a list of all contact center users with their extensions and DID numbers Get a list of all access numbers with ...
These methods enable retrieval of regular voice recordings (i.e., recordings where voices of all participating parties are recorded in the same audio file) and the related call ...
These methods enable sending of SMS and MMS messages and checking the delivery status. The response parameters are explained below. Response parameters Parameter Description ten...
With the https://:tenant_url/configapi/v2/user endpoint you can: Create new users and define most of their attributes Update existing users Check and clear user lockout state Ma...
Overlays applied on top of this provider's contracts. Each card says who wrote it: a document the provider publishes, or one API Evangelist derived or generated.
aid: bright-pattern
name: Bright Pattern
description: 'Bright Pattern is a cloud contact center (CCaaS) software company whose omnichannel platform routes voice, IVR,
email, chat, SMS/MMS, video and social messenger conversations to agents, with built-in quality management, workforce management,
outbound dialing and AI/bot assistance. The platform is multi-tenant: every customer contact center runs on its own tenant
hostname, and Bright Pattern exposes nine public REST API families against that tenant — Configuration, SCIM-compliant user
provisioning, List Management (v2, v3.0, v3.2), Task Routing, SMS/MMS, Interaction Content (call recordings and metadata),
Real-Time Statistics, and the Mobile/Web Messaging APIs (v1 and v2) that back the iOS and Android Mobile SDKs. The public
API reference is published as Postman documenter collections linked from the Bright Pattern documentation wiki.'
deliveryModel:
model: saas
open_source: false
commercial: true
callable_host: false
label: Hosted service · you call their endpoint
confidence: medium
source:
- openapi
- pricing
generated: '2026-08-28'
method: derived
accessModel:
pricing: paid
onboarding: unknown
trial: false
try_now: false
public: false
label: Paid
confidence: medium
source:
- plans
- authentication
- security
generated: '2026-11-06'
method: derived
image: https://www.brightpattern.com/wp-content/uploads/2025/02/Brightpattern-Homepage-Logo.png
url: https://raw.githubusercontent.com/api-evangelist/bright-pattern/refs/heads/main/apis.yml
x-type: company
x-source: harvest:secondary-market
specificationVersion: '0.23'
created: '2026-08-08'
modified: '2026-08-08'
x-docs-platform: postman
x-docs-platform-confidence: medium
x-docs-platform-checked: 2026-09-20
tags:
- Company
- Contact Center
- CCaaS
- Customer Experience
- Omnichannel
- Call Center
- Telephony
- Messaging
- SMS
- Voice
- Customer Service
- Workforce Management
maintainers:
- FN: Kin Lane
email: kin@apievangelist.com
- FN: APIs.json
email: info@apis.io
apis:
- aid: bright-pattern:bright-pattern-authentication-api
name: Bright Pattern Authentication API
description: 'The OAuth 2.0 Client Credentials Grant is used to authenticate clients of this API. The authenticated user
is checked for having appropriate privileges to perform the requested operation. The complete list of privileges can be
found here. Privileges are assigned to users via one or more Roles.
To obtain an access token:
Login to your BPCC configuraiton portal.
Navigate to Users page.
Select or create a user with privileges corresponding to the tasks you wish to perform via the BPCC Configuraiton API.
Click the Generate button to generate an API secret key. Copy the generated key and note the username for the next steps.
Use the Get Access Token method to obtain an access token. Set the client_id to the username and client_secret to the
generated API secrect key.
Use the value of access_token returned in the response to set the Authorization: Bearer [access token] header of each
subsequent request made via the BPCC Configuraiton API.'
humanURL: https://help.brightpattern.com/latest:Api
baseURL: https://{tenant}.brightpattern.com/configapi/v2
tags:
- Authentication
properties:
- type: OpenAPI
url: openapi/bright-pattern-authentication-api-openapi.yml
- type: Postman
url: https://documenter.getpostman.com/view/6711197/S1EUtanN
- type: Postman
url: https://documenter.getpostman.com/view/8336025/SVYwJbLw
- type: Postman
url: https://documenter.getpostman.com/view/8336025/2sB3WmV3UC
- type: Postman
url: https://documenter.getpostman.com/view/8336025/2sA3Qy5U4z
- type: Postman
url: https://documenter.getpostman.com/view/6735878/T1DtdFDu
- type: Postman
url: https://documenter.getpostman.com/view/31590362/2sA3XTfLhk
- type: Postman
url: https://documenter.getpostman.com/view/6711197/S1ETRbny
- type: Postman
url: https://documenter.getpostman.com/view/6711197/S1EUtb1f
- type: Postman
url: https://documenter.getpostman.com/view/6735878/T1DwbtSk
- type: Postman
url: https://documenter.getpostman.com/view/6735878/TzXwFJFP
- type: Postman
url: https://documenter.getpostman.com/view/6735877/T1LHGpBY
- aid: bright-pattern:bright-pattern-calling-list-api
name: Bright Pattern Calling List API
description: The Calling List API from Bright Pattern — 8 operation(s) for calling list.
humanURL: https://help.brightpattern.com/latest:Api
baseURL: https://{tenant}.brightpattern.com/configapi/v2
tags:
- Calling List
properties:
- type: OpenAPI
url: openapi/bright-pattern-calling-list-api-openapi.yml
- type: Postman
url: https://documenter.getpostman.com/view/6711197/S1EUtanN
- type: Postman
url: https://documenter.getpostman.com/view/8336025/SVYwJbLw
- type: Postman
url: https://documenter.getpostman.com/view/8336025/2sB3WmV3UC
- type: Postman
url: https://documenter.getpostman.com/view/8336025/2sA3Qy5U4z
- type: Postman
url: https://documenter.getpostman.com/view/6735878/T1DtdFDu
- type: Postman
url: https://documenter.getpostman.com/view/31590362/2sA3XTfLhk
- type: Postman
url: https://documenter.getpostman.com/view/6711197/S1ETRbny
- type: Postman
url: https://documenter.getpostman.com/view/6711197/S1EUtb1f
- type: Postman
url: https://documenter.getpostman.com/view/6735878/T1DwbtSk
- type: Postman
url: https://documenter.getpostman.com/view/6735878/TzXwFJFP
- type: Postman
url: https://documenter.getpostman.com/view/6735877/T1LHGpBY
- aid: bright-pattern:bright-pattern-campaigns-api
name: Bright Pattern Campaigns API
description: The Campaigns API from Bright Pattern — 27 operation(s) for campaigns.
humanURL: https://help.brightpattern.com/latest:Api
baseURL: https://{tenant}.brightpattern.com/configapi/v2
tags:
- Campaigns
properties:
- type: OpenAPI
url: openapi/bright-pattern-campaigns-api-openapi.yml
- type: Postman
url: https://documenter.getpostman.com/view/6711197/S1EUtanN
- type: Postman
url: https://documenter.getpostman.com/view/8336025/SVYwJbLw
- type: Postman
url: https://documenter.getpostman.com/view/8336025/2sB3WmV3UC
- type: Postman
url: https://documenter.getpostman.com/view/8336025/2sA3Qy5U4z
- type: Postman
url: https://documenter.getpostman.com/view/6735878/T1DtdFDu
- type: Postman
url: https://documenter.getpostman.com/view/31590362/2sA3XTfLhk
- type: Postman
url: https://documenter.getpostman.com/view/6711197/S1ETRbny
- type: Postman
url: https://documenter.getpostman.com/view/6711197/S1EUtb1f
- type: Postman
url: https://documenter.getpostman.com/view/6735878/T1DwbtSk
- type: Postman
url: https://documenter.getpostman.com/view/6735878/TzXwFJFP
- type: Postman
url: https://documenter.getpostman.com/view/6735877/T1LHGpBY
- aid: bright-pattern:bright-pattern-dnc-lists-api
name: Bright Pattern DNC Lists API
description: "Bright Pattern's List Management API makes it easy to manage the contents of Do Not Call (DNC) lists with\
\ bulk delete, add, and replace actions. The API methods described in this section fully support Internal, Geographic\
\ (Postal), Geographic (Area codes), and Record Exclusion DNC list types. Geographic (State/Province) DNC List type is\
\ not supported in the current implementation.\n\nNote: Performing operations on DNC lists requires the user to have the\
\ \"Manage Lists\" privilege, configured in the Contact Center Administrator application.\n\nThe functionality of the\
\ API methods described in this section is built upon a DNC List Record JSON Object with a required non-empty key field\
\ and an optional comment field. Depending on the DNC list type, the object's field values vary as follows:\n\nDNC List\
\ Type\nField Values\n\nInternal\nkey (required field): Phone number \ncomment (optional field): Campaign Name\n\nGeographic\
\ (Postal)\nkey (required field): Postal Code \ncomment (optional field): Notes\n\nGeographic (Area Codes)\nkey (required\
\ field): Area code \ncomment (optional field): Notes\n\nRecord Exclusion\nkey (required field): Exclusion field \n\
comment (optional field): -\n\nNote: When importing records or updating records it is important to remember that:\n\n\
All leading and trailing whitespaces should be deleted.\n\nAll integer values should be converted to strings.\n\nCapitalization\
\ matters: values with different capitalizations are treated as distinct.\n\nThe search can be performed by both the original\
\ values created in third-party systems and their transformed equivalents visible in the Administrator Application and\
\ Agent Desktop."
humanURL: https://help.brightpattern.com/latest:Api
baseURL: https://{tenant}.brightpattern.com/configapi/v2
tags:
- DNC Lists
properties:
- type: OpenAPI
url: openapi/bright-pattern-dnc-lists-api-openapi.yml
- type: Postman
url: https://documenter.getpostman.com/view/6711197/S1EUtanN
- type: Postman
url: https://documenter.getpostman.com/view/8336025/SVYwJbLw
- type: Postman
url: https://documenter.getpostman.com/view/8336025/2sB3WmV3UC
- type: Postman
url: https://documenter.getpostman.com/view/8336025/2sA3Qy5U4z
- type: Postman
url: https://documenter.getpostman.com/view/6735878/T1DtdFDu
- type: Postman
url: https://documenter.getpostman.com/view/31590362/2sA3XTfLhk
- type: Postman
url: https://documenter.getpostman.com/view/6711197/S1ETRbny
- type: Postman
url: https://documenter.getpostman.com/view/6711197/S1EUtb1f
- type: Postman
url: https://documenter.getpostman.com/view/6735878/T1DwbtSk
- type: Postman
url: https://documenter.getpostman.com/view/6735878/TzXwFJFP
- type: Postman
url: https://documenter.getpostman.com/view/6735877/T1LHGpBY
- aid: bright-pattern:bright-pattern-do-not-call-list-api
name: Bright Pattern Do Not Call List API
description: The Do Not Call List API from Bright Pattern — 4 operation(s) for do not call list.
humanURL: https://help.brightpattern.com/latest:Api
baseURL: https://{tenant}.brightpattern.com/configapi/v2
tags:
- Do Not Call List
properties:
- type: OpenAPI
url: openapi/bright-pattern-do-not-call-list-api-openapi.yml
- type: Postman
url: https://documenter.getpostman.com/view/6711197/S1EUtanN
- type: Postman
url: https://documenter.getpostman.com/view/8336025/SVYwJbLw
- type: Postman
url: https://documenter.getpostman.com/view/8336025/2sB3WmV3UC
- type: Postman
url: https://documenter.getpostman.com/view/8336025/2sA3Qy5U4z
- type: Postman
url: https://documenter.getpostman.com/view/6735878/T1DtdFDu
- type: Postman
url: https://documenter.getpostman.com/view/31590362/2sA3XTfLhk
- type: Postman
url: https://documenter.getpostman.com/view/6711197/S1ETRbny
- type: Postman
url: https://documenter.getpostman.com/view/6711197/S1EUtb1f
- type: Postman
url: https://documenter.getpostman.com/view/6735878/T1DwbtSk
- type: Postman
url: https://documenter.getpostman.com/view/6735878/TzXwFJFP
- type: Postman
url: https://documenter.getpostman.com/view/6735877/T1LHGpBY
- aid: bright-pattern:bright-pattern-link-groups-api
name: Bright Pattern Link Groups API
description: Bright Pattern's List Management API provides the ability to manage Link Groups so several campaigns can be
linked together. When processing all records of one campaign is finished, the next campaign in the group will be started
automatically. Additionally, see the Link a Campaign and Unlink a Campaign methods descriptions.
humanURL: https://help.brightpattern.com/latest:Api
baseURL: https://{tenant}.brightpattern.com/configapi/v2
tags:
- Link Groups
properties:
- type: OpenAPI
url: openapi/bright-pattern-link-groups-api-openapi.yml
- type: Postman
url: https://documenter.getpostman.com/view/6711197/S1EUtanN
- type: Postman
url: https://documenter.getpostman.com/view/8336025/SVYwJbLw
- type: Postman
url: https://documenter.getpostman.com/view/8336025/2sB3WmV3UC
- type: Postman
url: https://documenter.getpostman.com/view/8336025/2sA3Qy5U4z
- type: Postman
url: https://documenter.getpostman.com/view/6735878/T1DtdFDu
- type: Postman
url: https://documenter.getpostman.com/view/31590362/2sA3XTfLhk
- type: Postman
url: https://documenter.getpostman.com/view/6711197/S1ETRbny
- type: Postman
url: https://documenter.getpostman.com/view/6711197/S1EUtb1f
- type: Postman
url: https://documenter.getpostman.com/view/6735878/T1DwbtSk
- type: Postman
url: https://documenter.getpostman.com/view/6735878/TzXwFJFP
- type: Postman
url: https://documenter.getpostman.com/view/6735877/T1LHGpBY
- aid: bright-pattern:bright-pattern-lists-api
name: Bright Pattern Lists API
description: 'Bright Pattern''s List Management API streamlines the creation and deletion of lists and formats and provides
a convenient way to manage list records.
Note: Performing operations on lists requires the user to have the "Manage Lists" privilege, configured in the Contact
Center Administrator application. Additional privileges required are explicitly specified in the corresponding method
description.
All of the methods described below use the path variable, list_id, to specify the list an operation is to be performed
on. The unique identifier of a list can be found by opening that list in the Contact Center Administrator application,
Lists section. The id will be displayed in the ''#LISTS:LISTS_PROPERTIES:'' fragment of the URL.
Alternatively, list_id, can be found in the response body of the Get Lists method (see here).
Methods retained from the previous version of the List management API, tagged as "DEPRECIATED", require an additional
path variable, campaign_id, to reference the campaign associated with the selected list. The unique identifier of a campaign
can be found by opening that campaign in the Contact Center Administrator application, Services & Campaigns section. The
id will be displayed in the ''#SERVICES_CAMPAIGNS:SERVICES_PROPERTIES:'' fragment of the URL.
Alternatively, campaign_id, can be found in the response body of the Get Campaigns method (see here).
Note: When importing records or updating records it is important to remember that:
All leading and trailing whitespaces should be deleted.
For all PHONE numbers:
If a number begins with “+”, the leading "+" sign will be removed.
If a number contains non-numeric characters, they will be removed.
At least one PHONE number is required.
For the United States and Canada PHONE numbers:
If a number begins with “011”, it will be kept as is.
If a number begins with “1” and has eleven digits, it will be kept as is.
If a number does not begin with “1” and has ten digits, “1” will be prepended.
If a number begins with “1” and has ten digits, the record will not be imported, returning a format error.
In any other case, the record will not be imported, returning a format error.
Remove prefix and Default country code fields will be ignored.
For Other countries PHONE numbers:
If a number begins with prefix matching Remove prefix, the prefix will be deleted.
If a number does not begin with prefix matching Remove prefix, it will be kept as is.
If a number does not begin with prefix matching Default country code, Default country code will be added.
For all INTEGER fields:
If the value is presented as a string, it should be converted to an integer.
Values presented as integers should be supported.
For all fields that expect strings (ACCOUNT, AGENT_LOGIN_ID, FIRST_NAME, LAST_NAME, etc.) integer values should be converted
to strings.
Capitalization matters: values with different capitalizations are treated as distinct.
For all DATE/TIME and DATE/TIME - SCHEDULE CALL AT fields:
If a…'
humanURL: https://help.brightpattern.com/latest:Api
baseURL: https://{tenant}.brightpattern.com/configapi/v2
tags:
- List
tags_raw:
- Lists
properties:
- type: OpenAPI
url: openapi/bright-pattern-lists-api-openapi.yml
- type: Postman
url: https://documenter.getpostman.com/view/6711197/S1EUtanN
- type: Postman
url: https://documenter.getpostman.com/view/8336025/SVYwJbLw
- type: Postman
url: https://documenter.getpostman.com/view/8336025/2sB3WmV3UC
- type: Postman
url: https://documenter.getpostman.com/view/8336025/2sA3Qy5U4z
- type: Postman
url: https://documenter.getpostman.com/view/6735878/T1DtdFDu
- type: Postman
url: https://documenter.getpostman.com/view/31590362/2sA3XTfLhk
- type: Postman
url: https://documenter.getpostman.com/view/6711197/S1ETRbny
- type: Postman
url: https://documenter.getpostman.com/view/6711197/S1EUtb1f
- type: Postman
url: https://documenter.getpostman.com/view/6735878/T1DwbtSk
- type: Postman
url: https://documenter.getpostman.com/view/6735878/TzXwFJFP
- type: Postman
url: https://documenter.getpostman.com/view/6735877/T1LHGpBY
- aid: bright-pattern:bright-pattern-methods-api
name: Bright Pattern Methods API
description: The Methods API from Bright Pattern — 32 operation(s) for methods.
humanURL: https://help.brightpattern.com/latest:Api
baseURL: https://{tenant}.brightpattern.com/configapi/v2
tags: []
tags_raw:
- Methods
properties:
- type: OpenAPI
url: openapi/bright-pattern-methods-api-openapi.yml
- type: Postman
url: https://documenter.getpostman.com/view/6711197/S1EUtanN
- type: Postman
url: https://documenter.getpostman.com/view/8336025/SVYwJbLw
- type: Postman
url: https://documenter.getpostman.com/view/8336025/2sB3WmV3UC
- type: Postman
url: https://documenter.getpostman.com/view/8336025/2sA3Qy5U4z
- type: Postman
url: https://documenter.getpostman.com/view/6735878/T1DtdFDu
- type: Postman
url: https://documenter.getpostman.com/view/31590362/2sA3XTfLhk
- type: Postman
url: https://documenter.getpostman.com/view/6711197/S1ETRbny
- type: Postman
url: https://documenter.getpostman.com/view/6711197/S1EUtb1f
- type: Postman
url: https://documenter.getpostman.com/view/6735878/T1DwbtSk
- type: Postman
url: https://documenter.getpostman.com/view/6735878/TzXwFJFP
- type: Postman
url: https://documenter.getpostman.com/view/6735877/T1LHGpBY
- aid: bright-pattern:bright-pattern-multichannel-call-recordings-api
name: Bright Pattern Multichannel Call Recordings API
description: "These methods are used to extract individual segments of multichannel call recordings (i.e., recordings where\
\ voice of each paricipating party is recorded into a separate audio file).\n\nThe Get Multichannel Recording Structure\
\ method should be used first to obtain the Interaction IDs, Party IDs, and optionally segments, to be used in the subsequent\
\ Get Multichannel Recording Segment Audio File requests.\n\nSegments of multichannel recordings are available for export\
\ immediately upon call termination. \n\nSegments of multichannel recordings are exported in uncompressed PCM format for\
\ maximun speech quality. Note that because of the large size of multichannel PCM recording files, they are typically\
\ stored in the system for a limited amount of time. Check with your service provider about your limits, and consider\
\ overnight export of selected recordings for the previous working day."
humanURL: https://help.brightpattern.com/latest:Api
baseURL: https://{tenant}.brightpattern.com/configapi/v2
tags:
- Multichannel Call Recordings
properties:
- type: OpenAPI
url: openapi/bright-pattern-multichannel-call-recordings-api-openapi.yml
- type: Postman
url: https://documenter.getpostman.com/view/6711197/S1EUtanN
- type: Postman
url: https://documenter.getpostman.com/view/8336025/SVYwJbLw
- type: Postman
url: https://documenter.getpostman.com/view/8336025/2sB3WmV3UC
- type: Postman
url: https://documenter.getpostman.com/view/8336025/2sA3Qy5U4z
- type: Postman
url: https://documenter.getpostman.com/view/6735878/T1DtdFDu
- type: Postman
url: https://documenter.getpostman.com/view/31590362/2sA3XTfLhk
- type: Postman
url: https://documenter.getpostman.com/view/6711197/S1ETRbny
- type: Postman
url: https://documenter.getpostman.com/view/6711197/S1EUtb1f
- type: Postman
url: https://documenter.getpostman.com/view/6735878/T1DwbtSk
- type: Postman
url: https://documenter.getpostman.com/view/6735878/TzXwFJFP
- type: Postman
url: https://documenter.getpostman.com/view/6735877/T1LHGpBY
- aid: bright-pattern:bright-pattern-phones-api
name: Bright Pattern Phones API
description: 'With the https://:tenant/configapi/v2/phone endpoint you can:
Get a list of all contact center users with their extensions and DID numbers
Get a list of all access numbers with thier current assignments (assigned users for DIDs and assigned scenarios for routing
points)'
humanURL: https://help.brightpattern.com/latest:Api
baseURL: https://{tenant}.brightpattern.com/configapi/v2
tags:
- Phone
tags_raw:
- Phones
properties:
- type: OpenAPI
url: openapi/bright-pattern-phones-api-openapi.yml
- type: Postman
url: https://documenter.getpostman.com/view/6711197/S1EUtanN
- type: Postman
url: https://documenter.getpostman.com/view/8336025/SVYwJbLw
- type: Postman
url: https://documenter.getpostman.com/view/8336025/2sB3WmV3UC
- type: Postman
url: https://documenter.getpostman.com/view/8336025/2sA3Qy5U4z
- type: Postman
url: https://documenter.getpostman.com/view/6735878/T1DtdFDu
- type: Postman
url: https://documenter.getpostman.com/view/31590362/2sA3XTfLhk
- type: Postman
url: https://documenter.getpostman.com/view/6711197/S1ETRbny
- type: Postman
url: https://documenter.getpostman.com/view/6711197/S1EUtb1f
- type: Postman
url: https://documenter.getpostman.com/view/6735878/T1DwbtSk
- type: Postman
url: https://documenter.getpostman.com/view/6735878/TzXwFJFP
- type: Postman
url: https://documenter.getpostman.com/view/6735877/T1LHGpBY
- aid: bright-pattern:bright-pattern-regular-call-recordings-api
name: Bright Pattern Regular Call Recordings API
description: 'These methods enable retrieval of regular voice recordings (i.e., recordings where voices of all participating
parties are recorded in the same audio file) and the related call metadata. Both audio files and metadata can be retrieved
immediately upon call termination. Parameters required for recording identificaiton can be obtained via scenario variables
$(item.globalInteractionId) and $(item.interactionStepId).
Regular call recordings are exported in GSM format.'
humanURL: https://help.brightpattern.com/latest:Api
baseURL: https://{tenant}.brightpattern.com/configapi/v2
tags:
- Regular Call Recordings
properties:
- type: OpenAPI
url: openapi/bright-pattern-regular-call-recordings-api-openapi.yml
- type: Postman
url: https://documenter.getpostman.com/view/6711197/S1EUtanN
- type: Postman
url: https://documenter.getpostman.com/view/8336025/SVYwJbLw
- type: Postman
url: https://documenter.getpostman.com/view/8336025/2sB3WmV3UC
- type: Postman
url: https://documenter.getpostman.com/view/8336025/2sA3Qy5U4z
- type: Postman
url: https://documenter.getpostman.com/view/6735878/T1DtdFDu
- type: Postman
url: https://documenter.getpostman.com/view/31590362/2sA3XTfLhk
- type: Postman
url: https://documenter.getpostman.com/view/6711197/S1ETRbny
- type: Postman
url: https://documenter.getpostman.com/view/6711197/S1EUtb1f
- type: Postman
url: https://documenter.getpostman.com/view/6735878/T1DwbtSk
- type: Postman
url: https://documenter.getpostman.com/view/6735878/TzXwFJFP
- type: Postman
url: https://documenter.getpostman.com/view/6735877/T1LHGpBY
- aid: bright-pattern:bright-pattern-sms-mms-messaging-api
name: Bright Pattern SMS/MMS Messaging API
description: 'These methods enable sending of SMS and MMS messages and checking the delivery status. The response parameters
are explained below.
Response parameters
Parameter
Description
tenant_id
Unique identifier of your contact center in BPCC configuraiton.
api_version
API version.
body
Text of the message.
num_segments
Number of segments in the transmitted message. Messages exceeding 160 characters are transmitted in multiple segements.
In the current verison of API this parameters is always set to 1.
num_media
Number of media files in the MMS message.
date_created
Timestamp of the original Send Message request.
date_sent
Timestamp of message transmission. Set to "null" in responses to Send Message requests. Set to actual time when the message
was sent in responses to Get Message requests.
date_updated
Reserved.
direction
Always set to outboound-api.
error_code
Error code.
error_message
Error message.
from
Origin number or, if a messenger integration is being used, the messenger type and integration ID.
price
Reserved. In the current version of the API always set to null.
sid
Unique identifier of the message. Retured in response to a Send Message request and can be used in Get Message to check
the delivery status of the message.
status
Status of message delivery. Possible values: queued (message queued to be sent), sent (message sent to SMS/MMS service
provider but delivery not confirmed), delivered (message confirmed by SMS service provider to be delivered; currently
not available for MMS), failed (message could not be sent; typically more details will be provided in error_message).
Note that a 200 OK response to a Send Message request will always have status set to queued. Actual status of message
delivery can be verified using the Get Message method with a slight delay.
to
Destination number or, if a messenger integration is being used, the messenger type and the messenger ID of the recipient.
uri
Reserved.'
humanURL: https://help.brightpattern.com/latest:Api
baseURL: https://{tenant}.brightpattern.com/configapi/v2
tags:
- SMS/MMS Messaging
properties:
- type: OpenAPI
url: openapi/bright-pattern-sms-mms-messaging-api-openapi.yml
- type: Postman
url: https://documenter.getpostman.com/view/6711197/S1EUtanN
- type: Postman
url: https://documenter.getpostman.com/view/8336025/SVYwJbLw
- type: Postman
url: https://documenter.getpostman.com/view/8336025/2sB3WmV3UC
- type: Postman
url: https://documenter.getpostman.com/view/8336025/2sA3Qy5U4z
- type: Postman
url: https://documenter.getpostman.com/view/6735878/T1DtdFDu
- type: Postman
url: https://documenter.getpostman.com/view/31590362/2sA3XTfLhk
- type: Postman
url: https://documenter.getpostman.com/view/6711197/S1ETRbny
- type: Postman
url: https://documenter.getpostman.com/view/6711197/S1EUtb1f
- type: Postman
url: https://documenter.getpostman.com/view/6735878/T1DwbtSk
- type: Postman
url: https://documenter.getpostman.com/view/6735878/TzXwFJFP
- type: Postman
url: https://documenter.getpostman.com/view/6735877/T1LHGpBY
- aid: bright-pattern:bright-pattern-task-routing-api
name: Bright Pattern Task Routing API
description: The following methods allow tasks within Bright Pattern Contact Center to be queued, canceled, updated, and
queried.
humanURL: https://help.brightpattern.com/latest:Api
baseURL: https://{tenant}.brightpattern.com/configapi/v2
tags:
- Task Routing
properties:
- type: OpenAPI
url: openapi/bright-pattern-task-routing-api-openapi.yml
- type: Postman
url: https://documenter.getpostman.com/view/6711197/S1EUtanN
- type: Postman
url: https://documenter.getpostman.com/view/8336025/SVYwJbLw
- type: Postman
url: https://documenter.getpostman.com/view/8336025/2sB3WmV3UC
- type: Postman
url: https://documenter.getpostman.com/view/8336025/2sA3Qy5U4z
- type: Postman
url: https://documenter.getpostman.com/view/6735878/T1DtdFDu
- type: Postman
url: https://documenter.getpostman.com/view/31590362/2sA3XTfLhk
- type: Postman
url: https://documenter.getpostman.com/view/6711197/S1ETRbny
- type: Postman
url: https://documenter.getpostman.com/view/6711197/S1EUtb1f
- type: Postman
url: https://documenter.getpostman.com/view/6735878/T1DwbtSk
- type: Postman
url: https://documenter.getpostman.com/view/6735878/TzXwFJFP
- type: Postman
url: https://documenter.getpostman.com/view/6735877/T1LHGpBY
- aid: bright-pattern:bright-pattern-users-api
name: Bright Pattern Users API
description: 'With the https://:tenant_url/configapi/v2/user endpoint you can:
Create new users and define most of their attributes
Update existing users
Check and clear user lockout state
Manage agents'' skills
Delete existing users
Below is a brief description of all user attributes that can be accessed via this API. More detailed descriptions of these
attributes can be found here.
All attributes are strings unless otherwise noted.
All attributes are optional unless otherwise noted.
Attribute
Description
loginId
Username. Required to create user. Used to identify the user in all subsequent User Management API operations.
password
Password. Format must comply with security policy.
changePassword
Indicates whether user must change password on next login. Boolean. Default is false.
firstName
First name. Required to create user.
lastName
Last name. Required to create user.
team
Team that the user is assigned to. Required to create user.
extension
User''s extension number. If not specified, an extension will be created and assigned automatically.
workPhone
User''s work phone number.
mobilePhone
User''s mobile phone number.
email
User''s email address.
disabled
Indication whether the user account is disabled or enabled. Boolean (true/flase).
skills
For agents an array of skills with levels (e.g., "Support": 75).
roles
An array of user''s roles (e.g., Agent).'
humanURL: https://help.brightpattern.com/latest:Api
baseURL: https://{tenant}.brightpattern.com/configapi/v2
tags:
- User
tags_raw:
- Users
properties:
- type: OpenAPI
url: openapi/bright-pattern-users-api-openapi.yml
- type: Postman
url: https://documenter.getpostman.com/view/6711197/S1EUtanN
- type: Postman
url: https://documenter.getpostman.com/view/8336025/SVYwJbLw
- type: Postman
url: https://documenter.getpostman.com/view/8336025/2sB3WmV3UC
- type: Postman
url: https://documenter.getpostman.com/view/8336025/2sA3Qy5U4z
- type: Postman
url: https://documenter.getpostman.com/view/6735878/T1DtdFDu
- type: Postman
url: https://documenter.getpostman.com/view/31590362/2sA3XTfLhk
- type: Postman
url: https://documenter.getpostman.com/view/6711197/S1ETRbny
- type: Postman
url: https://documenter.getpostman.com/view/6711197/S1EUtb1f
- type: Postman
url: https://documenter.getpostman.com/view/6735878/T1DwbtSk
- type: Postman
url: https://documenter.getpostman.com/view/6735878/TzXwFJFP
- type: Postman
url: https://documenter.getpostman.com/view/6735877/T1LHGpBY
common:
- type: Plans
url: plans/bright-pattern-plans-pricing.yml
- type: CapabilityMap
url: capabilities/bright-pattern-capability-edges.yml
name: Bright Pattern Business Capability Map
- type: X-MCPServerCandidate
url: mcp/bright-pattern-mcp.yml
note: 'Renamed from MCPServer 2026-09-03 (roadmap#247): the manifest self-describes as status: candidate — a tool list derived
from the published API contracts, not an existing server. The scorer already read the manifest and reported mcp_server
correctly; the MCPServer type was crediting the artifact-type surfaces with a server that does not exist.'
- type: AgenticAccess
url: agentic-access/bright-pattern-agentic-access.yml
# --- truncated at 32 KB (34 KB total) ---
# Full source: https://artifacts.apis.io/bright-pattern/apis.yml
Bright Pattern API — frequently asked questions
Does Bright Pattern have an API?
Yes. APIs.io lists 14 APIs from Bright Pattern, including Bright Pattern Authentication API, Bright Pattern Calling List API and Bright Pattern Campaigns API, and 11 more.
Is there an OpenAPI specification for the Bright Pattern API?
Yes. APIs.io indexes 14 OpenAPI specifications for Bright Pattern, each linked for download from this page.
How do I authenticate with the Bright Pattern API?
Bright Pattern uses bearer-token authentication (http/oauth2 · 2 schemes). The details are profiled on APIs.io as Bright Pattern Authentication.
How much does the Bright Pattern API cost?
Bright Pattern publishes its prices; its Call Center Standard plan is Request Quote as of 2026-10-28. APIs.io lists 4 pricing plans for Bright Pattern, with each plan's price, limits and inclusions under Pricing on this page.
Is the Bright Pattern API ready for AI agents?
Bright Pattern has a Kin Score of 60.1 out of 100 (strong) and an Agent Readiness score of 30.4 (agent-ready), scored by API Evangelist on 2026-11-06.
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
Kin Score
How this is scored →
It updates itself when the score changes. Paste this where you link to your API docs: