Skip to main content
GET
/
workspaces
List workspaces
curl --request GET \
  --url https://api.firma.dev/functions/v1/signing-request-api/workspaces \
  --header 'Authorization: <api-key>'
{
  "results": [
    {
      "id": "789e4567-e89b-12d3-a456-426614174000",
      "name": "Sales Workspace",
      "protected": false,
      "api_key": "fk_a1b2c3d4e5f6g7h8i9j0",
      "date_created": "2024-01-20T09:00:00Z",
      "date_changed": "2024-01-20T09:00:00Z"
    },
    {
      "id": "456e4567-e89b-12d3-a456-426614174000",
      "name": "Default Workspace",
      "protected": true,
      "api_key": "fk_z9y8x7w6v5u4t3s2r1q0",
      "date_created": "2024-01-15T10:30:00Z",
      "date_changed": "2024-01-15T10:30:00Z"
    }
  ],
  "pagination": {
    "current_page": 1,
    "page_size": 20,
    "total_count": 2,
    "total_pages": 1
  }
}

Authorizations

​
Authorization
string
header
required

API key for authentication. Use your API key directly without any prefix (e.g., 'your-api-key'). Bearer prefix is optional but not required.

Query Parameters

​
page
integer
default:1

Page number for pagination

Required range: x >= 1
​
page_size
integer
default:50

Number of items per page

Required range: 1 <= x <= 200
​
name
string

Filter by workspace name (partial match, case-insensitive)

​
protected
enum<string>

Filter by protected status

Available options:
0,
1,
true,
false
​
created_after
string<date-time>

Filter workspaces created after this date (ISO 8601 format)

​
created_before
string<date-time>

Filter workspaces created before this date (ISO 8601 format)

​
sort_by
enum<string>
default:created_on

Field to sort by

Available options:
name,
protected,
created_on
​
sort_order
enum<string>
default:desc

Sort order

Available options:
asc,
desc

Response

Workspaces retrieved successfully

​
results
object[]
​
pagination
object