Skip to main content
GET
Download Company Extract as PDF

Authorizations

x-api-key
string
header
required

Headers

x-topograph-workspace-id
string

Selects the workspace for this request: usage is attributed to it, and register credentials resolve from it. Takes the workspace name (the value you sent to POST /v2/workspaces), not the UUID id returned on creation. Omit to use the account's default workspace. Unknown name returns 404; a name outside ^[a-zA-Z0-9_-]+$ or over 64 characters returns 400.

Maximum string length: 64
Pattern: ^[a-zA-Z0-9_-]+$
Example:

"acme-paris"

Path Parameters

requestId
string
required

The request ID returned by the initial POST /v2/company call

Example:

"253299d1-e8d0-4268-945b-f175f98bc114"

Query Parameters

requireComplete
boolean

If true, respond 409 rather than render an extract while any requested datapoint is still in progress. Accepts true/false/1/0; any other value is rejected with 400. Defaults to false.

disposition
enum<string>

Controls Content-Disposition. attachment (default) prompts a download; inline lets a browser or viewer render the PDF in place.

Available options:
attachment,
inline

Response

The PDF extract. X-Topograph-Data-Status is complete when every requested datapoint reached a terminal state, partial otherwise.

The response is of type file.