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

Earnipay Team API

Team member and invitation management

Earnipay Team API is one of 13 APIs that Earnipay publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 6 operations across 6 paths, and defines 3 schemas. It is described by OpenAPI 3.0.0, at version 1.0.

Requests are made against the base URL https://e-invoicing.earnipay.com/v1.

6 operations 6 paths 3 schemas 2 DELETE1 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0
Base URL
https://e-invoicing.earnipay.com/v1
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

Earnipay Team API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (JWT-auth). An API key is passed in the header as X-API-Key (API-Key).

  • JWT-auth — Enter JWT token
  • API-Key — API Key for third-party integrations

Paths & Operations 6

Across 6 paths, the API surfaces 6 operations — 2 DELETE, 1 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Team 6

Team member and invitation management

POST
/v1/team/invite
Invite team member
TeamController_inviteTeamMember_v1 1 param body → 201400401403409
GET
/v1/team
Get team members
TeamController_getTeam_v1 6 params → 200401403
POST
/v1/team/invitations/{token}/accept
Accept team invitation
TeamController_acceptInvitation_v1 1 param body → 200400404409
DELETE
/v1/team/invitations/{id}
Revoke team invitation
TeamController_revokeInvitation_v1 2 params → 200400401403404
PATCH
/v1/team/members/{id}/role
Update team member role
TeamController_updateMemberRole_v1 2 params body → 200400401403404
DELETE
/v1/team/members/{id}
Remove team member
TeamController_removeMember_v1 2 params → 200400401403404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are AcceptInvitationDto (3 properties), InviteTeamMemberDto (2 properties), UpdateMemberRoleDto (1 property). Each schema is shown below with its type and property counts.

UpdateMemberRoleDto
object
1 property 1 required
AcceptInvitationDto
object
3 properties
InviteTeamMemberDto
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

earnipay-team-api-openapi.yml Raw ↑

Other APIs Earnipay publishes across the network.

Earnipay App API
Earnipay APP Provider API
Earnipay Authentication API
Earnipay Bank API
Earnipay Business API
Earnipay Customers API
Earnipay Invoices API
Earnipay IRN Generator API
Earnipay Payment Details API
Earnipay Products API
Earnipay QR Code Generator API
Earnipay Users API