List companies on this tenant

GET

/api/v3/teams/companies

const url = 'https://api.tryletterhead.com/api/v3/teams/companies';
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.tryletterhead.com/api/v3/teams/companies \
  --header 'Authorization: Bearer <token>'

The companies on this tenant a company-scoped grant may name.

Because of the access this exposes, this endpoint is restricted to Letterhead staff: it authenticates as a signed-in user with a @tryletterhead.com or @whereby.us email address rather than a company API key, so it is not available to external integrations.

Authorizations

bearerAuth

Responses

200

200 OK

application/json

object

items

Array<object>

object

slug

string

name

string

message

string

total

integer

Example

{
  "items": [
    {
      "slug": "amazing-example",
      "name": "Amazing Example"
    }
  ],
  "message": "",
  "total": 1
}

Still can’t find what you need? Contact support.