GET
/
teams
List Teams
curl --request GET \
  --url https://api.firma.dev/functions/v1/signing-request-api/teams \
  --header 'Authorization: <api-key>'
{
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "protected": true,
      "created_date": "2023-11-07T05:31:56Z",
      "updated_date": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "page": 123,
    "page_size": 123,
    "total_pages": 123,
    "total_items": 123
  }
}

Authorizations

​
Authorization
string
header
required

API key for authentication. Format: 'Bearer your-api-key'

Query Parameters

​
page
integer
default:1
Required range: x >= 1
​
page_size
integer
default:20
Required range: 1 <= x <= 100
​
search
string
Maximum length: 255

Response

200 - application/json

Teams retrieved successfully

​
results
object[]
​
pagination
object