openapi: 3.0.3
info:
title: Narmi Public account balances teams API
version: v1
description: To read about Public API access and authentication, go to [API Overview](https://docs.narmi.com/docs/narmi-developer-docs/xl9dvbz84o11l-introduction).
termsOfService: https://www.narmi.com/policies/developer-terms-conditions
contact:
name: Narmi Support
email: support@narmi.com
servers:
- url: https://api.sandbox.narmi.dev/
description: ''
tags:
- name: teams
paths:
/v1/teams/:
get:
operationId: teams_list
description: 'Lists the message center teams a user can message, used for group inboxes.
All monetary values are represented in minor units, or the smallest unit of the currency with no decimal (e.g., cents). For example, $10.00 is represented as 1000.
<i>How can we improve these docs? <a href="mailto:docs+feedback@narmi.com">Share your feedback.</a></i>'
summary: List teams
parameters:
- name: limit
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
maximum: 2147483648
- name: offset
required: false
in: query
description: The initial index from which to return the results.
schema:
type: integer
maximum: 2147483648
tags:
- teams
security:
- oauth2:
- read
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedTeamList'
description: ''
'500':
description: No response body
x-stoplight:
id: sqlup8hmn5zfv
components:
schemas:
PaginatedTeamList:
type: object
required:
- meta
- links
- results
properties:
results:
type: array
items:
$ref: '#/components/schemas/Team'
links:
type: object
description: URIs linking to sequential pages of the result.
properties:
next:
type: string
format: uri
nullable: true
example: https://narmi.example.com/v1/payments?after=400
prev:
type: string
format: uri
nullable: true
example: https://narmi.example.com/v1/payments?before=200
meta:
description: Free-form object, contains total object count.
type: object
properties:
total:
type: integer
x-stoplight:
id: aa5dcsaeijlgi
Team:
type: object
properties:
uuid:
type: string
format: uuid
readOnly: true
name:
type: string
readOnly: true
description:
type: string
readOnly: true
x-stoplight:
id: b6ww36jlgnhwy
securitySchemes:
oauth2:
type: oauth2
flows:
authorizationCode:
authorizationUrl: /v2/oauth/authorize/
tokenUrl: /v2/oauth/token/
scopes:
banking:accounts:read: Can read account information.
banking:transactions:read: Can read transaction information.
banking:scheduled_transfers:read: Can read scheduled transfer information.
banking:scheduled_transfers:write: Can create and update scheduled transfers.
banking:accounts:write: Can update account information.
banking:transactions:write: Can update transaction information.
banking:users:read: Can read user profile information.
banking:products:read: Can read product information.
banking:documents:read: Can read user statements and documents.
x-stoplight:
id: 68n444msv6n7x