---
title: "Get the organization and token behind the request"
method: GET
path: "/organization"
tags: ["Organization"]
---

# Get the organization and token behind the request

`GET /organization`

## Request

- Base URL: `https://trackberry.com/api/v1`
- URL: `https://trackberry.com/api/v1/organization`
- Auth: HTTP bearer

Use this first to check that a token works and to learn which organization it reads, which API version that organization is pinned to, and when the token expires. Read-only and cheap.

## Headers

- `Trackberry-Version` string

## Response `200`

The organization and the token used.

- Organization: The organization a token reads, with the token that made the request.
  - `object` 'organization', required: Always `organization`.
  - `id` string, required: The organization id.
  - `name` string, required: The organization's display name.
  - `slug` string, required: The organization's URL slug in the Trackberry app.
  - `api_version` string, nullable, required: The API version the organization is pinned to. Null only if the organization has not made a request without a `Trackberry-Version` header yet.
  - `token` object, required: The API token that authenticated this request.
    - `id` string, required: The token id (not the secret).
    - `name` string, required: The name given to the token when it was created.
    - `scopes` string[], required: What the token may do. `read` for every token; `write` as well for a token created as "Read and write", which lets it create and revoke customer links.
    - `expires_at` string, date-time, nullable, required: When the token stops working, or null if it never expires.
    - `user_email` string, required: The email of the user the token belongs to.

## Other responses

- `400`: A parameter or header is invalid (`invalid_parameter`, with `param` naming it), a customer link cannot be made for this shipment (`not_shareable`), an uploaded file is empty, over 50 MB or of a type Trackberry does not read (`file_empty`, `file_too_large`, `unsupported_file_type`), an upload's container number is on more than one live shipment (`ambiguous_container`), an `Idempotency-Key` was already used for a different request (`idempotency_key_reused`) or `Trackberry-Version` names an unpublished version (`invalid_version`, with `param` set to `Trackberry-Version`). A parameter that must be a single value but was sent as an array or hash (`status[]=x`, `q[a]=1`) is also a 400.
- `401`: No token was sent (`missing_token`) or the token is wrong, expired, revoked, or its user left the organization (`invalid_token`). The response has a `WWW-Authenticate` header.
- `403`: The token may not do this. `insufficient_scope`: a write endpoint was called with a read-only token. `read_only_member`: a write endpoint was called by a token whose owner is now a read-only member of the organization. `revoke_not_allowed`: the link can only be revoked by an admin or by the member who made it. `billing_blocked`: an upload needed a new shipment and the organization's billing does not allow one.
- `429`: A rate limit was hit (`rate_limited`). Wait the number of seconds in `Retry-After`. A BI feed answers the same way (`feed_in_progress`) when another feed for the organization is still being produced.

---

[API](https://skmtc.dev/trackberry/apis/trackberry-api.md) · [All operations](https://skmtc.dev/trackberry/apis/trackberry-api/llms.txt) · [OpenAPI document](https://skmtc.dev/trackberry/apis/trackberry-api/revisions/be06ee7c17f3?raw)