Method and URL
The heading shows the HTTP method and the full URL, for exampleGET https://my.flowsign.app/api/v1/packages/{packageId}. Segments in braces are path parameters. The description below it says what the endpoint does, the state the resource must be in, and the permission the key’s role needs.
Headers
Authorization takes your API key and sends it asBearer fsk_.... Every endpoint needs it.
X-Workspace-Id is optional on an ordinary key. Without it a call acts in the key’s default workspace; with it, in any workspace the key was issued for. Any other value returns 401. A key that acts for members must send it on every call. See Workspaces.
X-Act-As is required on a key that acts for members and refused on any other key. It names the member the call runs as, in key=value form such as email=jane@acme.com. See Keys that act for members.
Parameters
Path parameters are the braced segments of the URL, such aspackageId. Query parameters appear on GET endpoints: filters such as status and search, and page and pageSize on the paginated lists. Each lists its type, default and allowed values.
Request body
POST, PATCH and PUT endpoints take a JSON body. Each field shows its type, a required marker where one applies, its description and an example value. The examples are what the code samples are built from; swap them for your own before running one.
Responses
Responses are grouped by status code. Every endpoint declares these:
An endpoint also lists the codes specific to it:
400 (invalid JSON, or the action is not possible in the resource’s current state), 404 (not visible in the workspace the call acted in), 409 (conflicts with the resource’s state) and 413 (payload too large). Each tab’s description says which condition applies. All error bodies share the Error schema. See Errors and rate limits.

