Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Narmi threads API

The threads API from Narmi — 6 operation(s) for threads.

Narmi threads API is one of 44 APIs that Narmi publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include threads. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 9 operations across 6 paths, and defines 27 schemas. It is described by OpenAPI 3.0.3, at version v1.

Requests are made against a single base URL, https://api.sandbox.narmi.dev/.

9 operations 6 paths 27 schemas 4 GET3 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
v1
Base URL
https://api.sandbox.narmi.dev/
Authentication
OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 1

Narmi threads API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 9 scopes.

Paths & Operations 9

Across 6 paths, the API surfaces 9 operations — 4 GET, 3 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

threads 9
POST
/v1/thread_files/policies/
Create a signed request for uploading a file to S3
thread_files_policies_create body → 201400422
GET
/v1/threads/
List user's message threads
threads_list 4 params → 200
POST
/v1/threads/
Create message thread for a user
threads_create body → 201422
GET
/v1/threads/{thread_uuids}/messages/
List messages in a thread
threads_messages_list 1 param → 200404
POST
/v1/threads/{thread_uuids}/messages/
Create a message in a thread
user_messages_create 1 param body → 201404422
GET
/v1/threads/{thread_uuid}/messages/{uuid}/
Retrieve user messages
threads_messages_retrieve 2 params → 200404
GET
/v1/threads/{uuid}/
Retrieve a thread
threads_retrieve 1 param → 200404
PUT
/v1/threads/{uuid}/
Update user's thread
threads_update 1 param body → 200404422
PUT
/v1/threads/{uuid}/mark_read/
Modify thread mark read
threads_mark_read_update 1 param → 200

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are Profile (40 properties), ThreadUploadPolicyResponse (11 properties), Message (8 properties), Thread (7 properties). Each schema is shown below with its type and property counts.

Address
object
7 properties 4 required
ThreadCreateRequest
object
4 properties 1 required
Profile
object
40 properties
UserCategory4f2Enum
string
MessageCreateResponse
object
1 property 1 required
ThreadUpdateRequest
object
1 property
Message
object
8 properties
BusinessPermissionsField
object
3 properties 3 required
MessageCreateRequest
object
3 properties
NullEnum
ThreadUploadPolicyResponse
object
11 properties 11 required
MessagesResponse
object
1 property 1 required
IncomeSource
object
6 properties 2 required
ThreadsResponse
object
1 property 1 required
Thread
object
7 properties
MessageCreate
object
2 properties
NotFoundError
object
2 properties 1 required
StateFf1Enum
string
closed - closed open - open
MessageResponse
object
1 property 1 required
ThreadUploadPolicyCreateDocRequest
object
2 properties 2 required
ThreadResponse
object
1 property 1 required
OrgRoleEnum
string
ThreadFileRequest
object
Serializer for file uploads to threads that validates both URL and signature.
2 properties 2 required
InvalidRequestError
object
2 properties
UploadFileError
object
1 property
Phone
object
3 properties 1 required
IncomeTypeEnum
string
employed - Employed parttime - Part time notemployed - Not employed selfemployed - Self employed retirement - Retirement other - Other

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

narmi-threads-api-openapi.yml Raw ↑

Other APIs Narmi publishes across the network.

Narmi account balances API
Narmi accounts API
Narmi ach companies API
Narmi ach destinations API
Narmi ach import API
Narmi ach payments API
Narmi ach transfers API
Narmi alerts API
Narmi automatic savings enrollment API
Narmi card linked offers API
Narmi cards API
Narmi data access management API