Workspace

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

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.

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

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.

  • 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
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"
  }
}

List pending invitations

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

Returns the invitations into the workspace behind the API key that nobody has accepted yet, oldest first, with the role each person will get and the delivery status of their invitation email. An accepted invitation leaves this list and its person appears in GET /space/members.

Fields in the 200 response
  • invitations array of Invitation
    5 fields inside invitations
    • createdAt string

      CreatedAt is when the invitation was created (RFC3339).

      Example: 2026-10-20T08:30:00Z
    • deliveryStatus string

      DeliveryStatus is the invitation email's: pending until it is sent, then delivered or failed. disabled means no email is sent for it.

      One of: "pending", "delivered", "failed", "disabled". Example: pending
    • emailAddress string
      Example: jane@example.com
    • id integer
      Example: 42
    • role string

      Role is what the person gets on accepting: admin, member (shown in the app as Editor), va or viewer.

      One of: "admin", "member", "va", "viewer". Example: admin
  • total integer
    Example: 1

Request

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

Response

{
  "invitations": [
    {
      "createdAt": "2026-10-20T08:30:00Z",
      "deliveryStatus": "pending",
      "emailAddress": "jane@example.com",
      "id": 42,
      "role": "admin"
    }
  ],
  "total": 1
}

Invite people to the workspace

post https://api.emailchaser.com/r/space/invitations

Invites each address into the workspace behind the API key and emails each person a link to join. They join with the role given (admin, member, va or viewer; member is shown in the app as Editor and is the default), into this workspace only. Owner cannot be granted. The invitations are sent as the workspace's owner, under the same limits as inviting from the app: the plan's team seats, at most 25 addresses a call, and hourly, daily and open-invitation limits across the account. Pending invitations are listed by GET /space/invitations; once accepted, the person is a member (GET /space/members).

  • emailAddresses array of string required

    EmailAddresses are the people to invite, up to 25 per call. Each gets its own invitation and email; duplicates are sent once.

    At least 1 item. At most 25 items. Example: ["jane@example.com"]
  • role string

    Role is what they get on accepting. Defaults to member (Editor). Owner cannot be granted through an invitation.

    One of: "admin", "member", "va", "viewer". Example: admin
  • 201 The invitations created · InvitationsResult
  • 400 Invalid request: no address, a malformed address, more than 25 addresses or an unknown role · ErrorResponse
  • 401 Unauthorized - invalid or missing API key · ErrorUnauthorized
  • 403 Read-only key, or the plan's team seats or open-invitation limit are used up · ErrorResponse
  • 429 Too many invitations sent in the last hour or day · ErrorResponse
  • 500 Failed to create the invitations · ErrorResponse
  • 503 The invitation limits could not be checked; retry in a minute · ErrorResponse
Fields in the 201 response
  • invitations array of Invitation
    5 fields inside invitations
    • createdAt string

      CreatedAt is when the invitation was created (RFC3339).

      Example: 2026-10-20T08:30:00Z
    • deliveryStatus string

      DeliveryStatus is the invitation email's: pending until it is sent, then delivered or failed. disabled means no email is sent for it.

      One of: "pending", "delivered", "failed", "disabled". Example: pending
    • emailAddress string
      Example: jane@example.com
    • id integer
      Example: 42
    • role string

      Role is what the person gets on accepting: admin, member (shown in the app as Editor), va or viewer.

      One of: "admin", "member", "va", "viewer". Example: admin
  • total integer
    Example: 1

Request

curl -X POST "https://api.emailchaser.com/r/space/invitations" \
  -H "Authorization: Bearer $EMAILCHASER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "emailAddresses": [
    "jane@example.com"
  ],
  "role": "admin"
}'

Response

{
  "invitations": [
    {
      "createdAt": "2026-10-20T08:30:00Z",
      "deliveryStatus": "pending",
      "emailAddress": "jane@example.com",
      "id": 42,
      "role": "admin"
    }
  ],
  "total": 1
}

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.

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.

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

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.

  • 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
Fields in the 201 response
  • 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

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.

  • id integer required in path

    Workspace ID

  • 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
Fields in the 201 response
  • 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.