List workspaces

GET

/workspaces

const url = 'https://api.sendtruss.com/v1/workspaces?status=active';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.sendtruss.com/v1/workspaces?status=active' \
  --header 'Authorization: Bearer <token>'

Newest first, 50 to a page. Deleted workspaces are not listed.

Authorizations

http

Parameters

Query Parameters

status

string

Allowed values: active suspended

Only the workspaces in this state.

Responses

200

Paginated set of WorkspaceResource

application/json

object

data

required

Array<object>

WorkspaceResource

object

required

string

reference

required

Your reference for the customer.

string | null

name

required

string

timezone

required

string

locale

required

string

status

required

string

Allowed values: active suspended

created_at

required

string | null

sending

required

Whether email can go out from the workspace.

object

state

required

ready; blocked while your sending domain is missing or not verified, with the reason below; or waiting for a short while once your domain can send, while the workspace itself is set up to send.

string

Allowed values: ready waiting blocked

reason

required

Why it is blocked: suspended, no_identity when you have no sending domain, or identity_not_sendable when it isn’t verified. Null otherwise.

string | null

health

required

How recipients are treating the workspace’s email. A workspace whose bounces or complaints run high is throttled, then paused, so it can’t harm your other workspaces.

object

state

required

ramping while it builds a sending history, established, throttled or paused.

string

reason

required

What moved it into its state, or null.

string | null

since

required

When it entered its state.

string | null

links

required

object

first

required

string | null

last

required

string | null

prev

required

string | null

next

required

string | null

meta

required

object

path

required

Base path for paginator generated URLs.

string | null

per_page

required

Number of items shown per page.

integer

next_cursor

required

The “cursor” that points to the next set of items.

string | null

prev_cursor

required

The “cursor” that points to the previous set of items.

string | null

Example

{
  "data": [
    {
      "status": "active",
      "sending": {
        "state": "ready"
      }
    }
  ]
}

Headers

Request-Id

required

string format: uuid

This request’s id. Quote it when you ask us about the request.

401

The API key is missing, malformed, revoked or expired.

application/json

object

message

required

What went wrong, for a person to read. It may change, so branch on code.

string

code

required

What went wrong, for your code to branch on. A new code is not a breaking change.

string

Allowed values: unauthenticated

doc_url

required

The entry on our errors page that explains this code.

string format: uri

request_id

required

This request’s id, the same as its Request-Id header. Quote it when you ask us about the request.

string format: uuid

Example

{
  "code": "unauthenticated"
}

Headers

Request-Id

required

string format: uuid

This request’s id. Quote it when you ask us about the request.

422

The request is invalid. The code says why, and errors names each field at fault.

application/json

object

message

required

What went wrong, for a person to read. It may change, so branch on code.

string

code

required

What went wrong, for your code to branch on. A new code is not a breaking change.

string

Allowed values: validation_failed

errors

required

Each field that failed validation, by its path in the request, with its messages.

object

key

additional properties

Array<string>

doc_url

required

The entry on our errors page that explains this code.

string format: uri

request_id

required

This request’s id, the same as its Request-Id header. Quote it when you ask us about the request.

string format: uuid

Example

{
  "code": "validation_failed"
}

Headers

Request-Id

required

string format: uuid

This request’s id. Quote it when you ask us about the request.

429

Too many requests. Wait for the seconds in Retry-After.

application/json

object

message

required

What went wrong, for a person to read. It may change, so branch on code.

string

code

required

What went wrong, for your code to branch on. A new code is not a breaking change.

string

Allowed values: rate_limited

doc_url

required

The entry on our errors page that explains this code.

string format: uri

request_id

required

This request’s id, the same as its Request-Id header. Quote it when you ask us about the request.

string format: uuid

Example

{
  "code": "rate_limited"
}

Headers

Request-Id

required

string format: uuid

This request’s id. Quote it when you ask us about the request.

Retry-After

integer

Seconds to wait before trying again.