Docs/API reference

Workspace

Create workspaces and their API keys, read members, and set the billing profile that done-for-you orders use.

get /space/billing-profile Get the workspace billing profileput /space/billing-profile Set the workspace billing profileget /space/members Get workspace details and membersget /workspaces List workspacespost /workspaces Create a workspacepost /workspaces/{id}/api-keys Create an API key for a workspace

Get the workspace billing profile

get https://api.emailchaser.com/r/space/billing-profile
Works with a read-only key

Returns the registrant and postal contact details held for the workspace. These are the details filed with the registrar when the Done For You flow buys a domain, and the address a CAN-SPAM footer must carry. Returns 404 until a profile has been set.

Responses

Fields in the 200 response
  • billingProfile BillingProfile
    13 fields inside billingProfile
    • addressLineOne string
      Example: 1 Example Street
    • addressLineTwo string
      Example: Suite 200
    • city string
      Example: New York
    • company string
      Example: Acme Ltd
    • country string

      Country is an ISO 3166-1 alpha-2 code, uppercase.

      Example: US
    • firstName string
      Example: Jane
    • lastName string
      Example: Doe
    • phone string
      Example: 2125550142
    • phoneCc string

      PhoneCc is the telephone country calling code without the plus.

      Example: 1
    • postalAddress string

      PostalAddress is the address rendered on one line, ready to paste into a compliance footer. Read-only; it is derived from the fields above.

      Example: Acme Ltd, 1 Example Street, Suite 200, New York, NY 10001, US
    • postalCode string
      Example: 10001
    • state string
      Example: NY
    • updatedAt string

      UpdatedAt is when the profile was last written (RFC3339).

      Example: 2026-08-03T10:30:00Z

Request

curl -X GET "https://api.emailchaser.com/r/space/billing-profile" \
  -H "Authorization: Bearer $EMAILCHASER_API_KEY"

Response

{
  "billingProfile": {
    "addressLineOne": "1 Example Street",
    "addressLineTwo": "Suite 200",
    "city": "New York",
    "company": "Acme Ltd",
    "country": "US",
    "firstName": "Jane",
    "lastName": "Doe",
    "phone": "2125550142",
    "phoneCc": "1",
    "postalAddress": "Acme Ltd, 1 Example Street, Suite 200, New York, NY 10001, US",
    "postalCode": "10001",
    "state": "NY",
    "updatedAt": "2026-08-03T10:30:00Z"
  }
}

Set the workspace billing profile

put https://api.emailchaser.com/r/space/billing-profile
Needs a read and write key

Creates or replaces the workspace's registrant and postal contact details. Idempotent: sending the same body twice leaves the same state. Every field except addressLineTwo is required, because incomplete registrant details are filed with the registrar just as readily as complete ones. Set this before ordering domains through /dfy/orders.

Request bodyJSON · UpdateBillingProfileRequest

  • addressLineOne string required
    Example: 1 Example Street
  • addressLineTwo string
    Example: Suite 200
  • city string required
    Example: New York
  • company string required
    Example: Acme Ltd
  • country string required

    Country is an ISO 3166-1 alpha-2 code, e.g. US. Case-insensitive on input.

    Example: US
  • firstName string required
    Example: Jane
  • lastName string required
    Example: Doe
  • phone string required
    Example: 2125550142
  • phoneCc string required

    PhoneCc is the telephone country calling code without the plus, e.g. 1.

    Example: 1
  • postalCode string required
    Example: 10001
  • state string required
    Example: NY

Responses

Fields in the 200 response
  • billingProfile BillingProfile
    13 fields inside billingProfile
    • addressLineOne string
      Example: 1 Example Street
    • addressLineTwo string
      Example: Suite 200
    • city string
      Example: New York
    • company string
      Example: Acme Ltd
    • country string

      Country is an ISO 3166-1 alpha-2 code, uppercase.

      Example: US
    • firstName string
      Example: Jane
    • lastName string
      Example: Doe
    • phone string
      Example: 2125550142
    • phoneCc string

      PhoneCc is the telephone country calling code without the plus.

      Example: 1
    • postalAddress string

      PostalAddress is the address rendered on one line, ready to paste into a compliance footer. Read-only; it is derived from the fields above.

      Example: Acme Ltd, 1 Example Street, Suite 200, New York, NY 10001, US
    • postalCode string
      Example: 10001
    • state string
      Example: NY
    • updatedAt string

      UpdatedAt is when the profile was last written (RFC3339).

      Example: 2026-08-03T10:30:00Z

Request

curl -X PUT "https://api.emailchaser.com/r/space/billing-profile" \
  -H "Authorization: Bearer $EMAILCHASER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "addressLineOne": "1 Example Street",
  "addressLineTwo": "Suite 200",
  "city": "New York",
  "company": "Acme Ltd",
  "country": "US",
  "firstName": "Jane",
  "lastName": "Doe",
  "phone": "2125550142",
  "phoneCc": "1",
  "postalCode": "10001",
  "state": "NY"
}'

Response

{
  "billingProfile": {
    "addressLineOne": "1 Example Street",
    "addressLineTwo": "Suite 200",
    "city": "New York",
    "company": "Acme Ltd",
    "country": "US",
    "firstName": "Jane",
    "lastName": "Doe",
    "phone": "2125550142",
    "phoneCc": "1",
    "postalAddress": "Acme Ltd, 1 Example Street, Suite 200, New York, NY 10001, US",
    "postalCode": "10001",
    "state": "NY",
    "updatedAt": "2026-08-03T10:30:00Z"
  }
}

Get workspace details and members

get https://api.emailchaser.com/r/space/members
Works with a read-only key

Returns the workspace behind the API key: campaign counts broken down by status, and the list of members with their roles. Useful for confirming which workspace a key belongs to.

Responses

Fields in the 200 response
  • completed_campaigns integer
  • draft_campaigns integer
  • members array of MemberInfo
    3 fields inside members
    • created_at string
    • email_address string
    • name string
  • not_started_campaigns integer
  • paused_campaigns integer
  • running_campaigns integer
  • space_id integer
  • total_campaigns integer
  • total_members integer

Request

curl -X GET "https://api.emailchaser.com/r/space/members" \
  -H "Authorization: Bearer $EMAILCHASER_API_KEY"

Response

{
  "completed_campaigns": 123,
  "draft_campaigns": 123,
  "members": [
    {
      "created_at": "string",
      "email_address": "string",
      "name": "Jane Doe"
    }
  ],
  "not_started_campaigns": 123,
  "paused_campaigns": 123,
  "running_campaigns": 123,
  "space_id": 123,
  "total_campaigns": 123,
  "total_members": 123
}

List workspaces

get https://api.emailchaser.com/r/workspaces
Works with a read-only key

Lists the workspaces owned by the API key's workspace owner: the main workspace and its sub-workspaces. isCurrent marks the workspace the calling key is bound to.

Responses

Fields in the 200 response
  • total integer
    Example: 3
  • workspaces array of WorkspaceItem
    5 fields inside workspaces
    • createdAt string
      Example: 2026-08-19T10:30:00Z
    • iconUrl string

      IconURL is where the workspace's icon image can be loaded from. Empty when the workspace has none. Icons are uploaded in the app.

      Example: https://whitelabel-assets.emailchaser.com/workspace-icons/51539607552/1766000000-a1b2c3d4e5f6.png
    • id integer
      Example: 51539607552
    • isCurrent boolean

      IsCurrent is true for the workspace the calling API key is bound to.

      Example: false
    • name string
      Example: Acme Outbound

Request

curl -X GET "https://api.emailchaser.com/r/workspaces" \
  -H "Authorization: Bearer $EMAILCHASER_API_KEY"

Response

{
  "total": 3,
  "workspaces": [
    {
      "createdAt": "2026-08-19T10:30:00Z",
      "iconUrl": "https://whitelabel-assets.emailchaser.com/workspace-icons/51539607552/1766000000-a1b2c3d4e5f6.png",
      "id": 51539607552,
      "isCurrent": false,
      "name": "Acme Outbound"
    }
  ]
}

Create a workspace

post https://api.emailchaser.com/r/workspaces
Needs a read and write key

Creates a sub-workspace under the API key's main workspace and, by default, mints a read+write API key bound to the new workspace. The key's fullKey is returned exactly once and cannot be retrieved again, and it never outlives the caller: when the calling key has an expiry, the minted key carries the same expiresAt. Must be called with a main workspace's key: keys bound to sub-workspaces are refused. API keys are included in every plan; workspaces are a Professional-plan feature.

Request bodyJSON · CreateWorkspaceRequest

  • generateApiKey boolean

    GenerateApiKey mints a read+write API key bound to the new workspace. Defaults to true; pass false to create the workspace only.

    Example: true
  • name string required

    Name of the new workspace. Trimmed; 1-60 characters.

    Example: Acme Outbound

Responses

Fields in the 201 response
  • apiKey CreatedApiKey

    ApiKey is null when generateApiKey was false.

    5 fields inside apiKey
    • expiresAt string

      ExpiresAt is set when the key expires: it inherits the calling key's own expiry, so a temporary key never mints a permanent one. Null for keys minted by a non-expiring key.

      Example: 2026-09-07T12:00:00Z
    • fullKey string
      Example: run_abc12345_...
    • id integer
      Example: 12
    • name string
      Example: Acme Outbound key
    • scopes array of string
      Example: ["read","read_write"]
  • note string

    Note reminds integrators that fullKey is not retrievable later.

    Example: Store apiKey.fullKey now: it cannot be retrieved again.
  • workspace WorkspaceItem
    5 fields inside workspace
    • createdAt string
      Example: 2026-08-19T10:30:00Z
    • iconUrl string

      IconURL is where the workspace's icon image can be loaded from. Empty when the workspace has none. Icons are uploaded in the app.

      Example: https://whitelabel-assets.emailchaser.com/workspace-icons/51539607552/1766000000-a1b2c3d4e5f6.png
    • id integer
      Example: 51539607552
    • isCurrent boolean

      IsCurrent is true for the workspace the calling API key is bound to.

      Example: false
    • name string
      Example: Acme Outbound

Request

curl -X POST "https://api.emailchaser.com/r/workspaces" \
  -H "Authorization: Bearer $EMAILCHASER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "generateApiKey": true,
  "name": "Acme Outbound"
}'

Response

{
  "apiKey": {
    "expiresAt": "2026-09-07T12:00:00Z",
    "fullKey": "run_abc12345_...",
    "id": 12,
    "name": "Acme Outbound key",
    "scopes": [
      "read",
      "read_write"
    ]
  },
  "note": "Store apiKey.fullKey now: it cannot be retrieved again.",
  "workspace": {
    "createdAt": "2026-08-19T10:30:00Z",
    "iconUrl": "https://whitelabel-assets.emailchaser.com/workspace-icons/51539607552/1766000000-a1b2c3d4e5f6.png",
    "id": 51539607552,
    "isCurrent": false,
    "name": "Acme Outbound"
  }
}

Create an API key for a workspace

post https://api.emailchaser.com/r/workspaces/{id}/api-keys
Needs a read and write key

Mints an API key bound to a workspace the calling key already owns: its own workspace, or one of its sub-workspaces when called with a main workspace's key. The key returned by POST /r/workspaces is shown once and cannot be retrieved again, so this is how a workspace whose key was lost gets a new one without a UI step. The new key authorizes the named workspace only and never outlives the caller: when the calling key has an expiry, the minted key carries the same expiresAt. fullKey is returned exactly once.

Parameters

  • id integer required in path

    Workspace ID

Request bodyJSON · CreateWorkspaceApiKeyRequest

  • name string

    Name shown in the app's API key list. Defaults to "<workspace name> key". Trimmed; up to 60 characters.

    Example: VoiceDrop outbound key
  • readOnly boolean

    ReadOnly mints a key that can call GET routes and four POSTs that buy and send nothing (/r/audience/size, /r/setup/ping, /r/dfy/domains/check and /r/lead-finder/searches), and nothing else. Defaults to false, which mints a read+write key.

    Example: false

Responses

Fields in the 201 response
  • apiKey CreatedApiKey
    5 fields inside apiKey
    • expiresAt string

      ExpiresAt is set when the key expires: it inherits the calling key's own expiry, so a temporary key never mints a permanent one. Null for keys minted by a non-expiring key.

      Example: 2026-09-07T12:00:00Z
    • fullKey string
      Example: run_abc12345_...
    • id integer
      Example: 12
    • name string
      Example: Acme Outbound key
    • scopes array of string
      Example: ["read","read_write"]
  • note string

    Note reminds integrators that fullKey is not retrievable later.

    Example: Store apiKey.fullKey now: it cannot be retrieved again.
  • workspace WorkspaceItem
    5 fields inside workspace
    • createdAt string
      Example: 2026-08-19T10:30:00Z
    • iconUrl string

      IconURL is where the workspace's icon image can be loaded from. Empty when the workspace has none. Icons are uploaded in the app.

      Example: https://whitelabel-assets.emailchaser.com/workspace-icons/51539607552/1766000000-a1b2c3d4e5f6.png
    • id integer
      Example: 51539607552
    • isCurrent boolean

      IsCurrent is true for the workspace the calling API key is bound to.

      Example: false
    • name string
      Example: Acme Outbound

Request

curl -X POST "https://api.emailchaser.com/r/workspaces/123/api-keys" \
  -H "Authorization: Bearer $EMAILCHASER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "VoiceDrop outbound key",
  "readOnly": false
}'

Response

{
  "apiKey": {
    "expiresAt": "2026-09-07T12:00:00Z",
    "fullKey": "run_abc12345_...",
    "id": 12,
    "name": "Acme Outbound key",
    "scopes": [
      "read",
      "read_write"
    ]
  },
  "note": "Store apiKey.fullKey now: it cannot be retrieved again.",
  "workspace": {
    "createdAt": "2026-08-19T10:30:00Z",
    "iconUrl": "https://whitelabel-assets.emailchaser.com/workspace-icons/51539607552/1766000000-a1b2c3d4e5f6.png",
    "id": 51539607552,
    "isCurrent": false,
    "name": "Acme Outbound"
  }
}

Generated from the Emailchaser API's own OpenAPI definition, so it always matches the running API.