Peach Finance

Teams

Create team

Create a new team

Securityoauth2 or bearerAuth or apiKeyHeader
Request
Request Body schema: application/json
required
name
string non-empty

The name of the team—e.g., "Engineering", "Operations", "Customer Support". Must be unique.

externalId
string or null

The lender's external identifier of the team.

email
string or null

The group email (or listserve) associated with this team.

Responses
200

Success

post/teams
Request samples
application/json
{
  • "name": "string",
  • "externalId": "string",
  • "email": "string"
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Get teams

Get all teams in a company

Securityoauth2 or bearerAuth or apiKeyHeader
Request
query Parameters
sortBy
Array of strings

The data attributes by which to sort the results.

offset
integer >= 0

Offset from the start of results.

limit
integer [ 1 .. 100 ]
Default: 25

The maximum count of results to retrieve.

startingAfter
string

Return results starting after the provided object identifier.

endingBefore
string

Return results ending before the provided object identifier.

Responses
200

Success

get/teams
Response samples
application/json
{
  • "status": 0,
  • "total": 0,
  • "count": 0,
  • "nextUrl": "string",
  • "previousUrl": "string",
  • "data": [
    ]
}

Update

Update team

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
teamId
required
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

The unique team identifier.

Request Body schema: application/json
required
name
string non-empty

The name of the team—e.g., "Engineering", "Operations", "Customer Support". Must be unique.

externalId
string or null

The lender's external identifier of the team.

email
string or null

The group email (or listserve) associated with this team.

Responses
200

Success

put/teams/{teamId}
Request samples
application/json
{
  • "name": "string",
  • "externalId": "string",
  • "email": "string"
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Get team by ID

Get team by ID

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
teamId
required
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

The unique team identifier.

Responses
200

Success

get/teams/{teamId}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Delete team

Delete team

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
teamId
required
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

The unique team identifier.

Responses
204

Success no content

delete/teams/{teamId}
➔ Next to Users