ZEzenzap
Org units

Get an org unit

Get a single org unit in your organization, including its member IDs.

Note: For security reasons, a 404 is returned both when the org unit does not exist and when it belongs to a different organization.

Org-unit restriction: If your organization restricts communication to within org units, your bot must be a member of the org unit; otherwise a 404 is returned. A bot that does not belong to any org unit cannot access any of them (every org unit returns 404).

get/v2/org-units/{orgUnitId}

Request

Path parameters

orgUnitIdstring uuid required

The ID of the org unit

Headers

X-Signaturestring
Example:a3d5f8e7c2b1d4f6a8e9c7b5d3f1a2e4b6c8d0f2e4a6b8c0d2e4f6a8b0c2d4e6

HMAC signature of the request for authentication and replay protection.

Required only when authenticating with a static API key. If you are using an OAuth access token (issued by POST /oauth/token), omit this header — the JWT carries all the authentication and integrity guarantees.

Replay Protection: The signature includes a timestamp to prevent replay attacks. Requests with timestamps older than 5 minutes are rejected.

The signature payload differs by HTTP method:

  • POST/PUT/PATCH/DELETE: HMAC-SHA256 of {timestamp}.{body}
  • GET: HMAC-SHA256 of {timestamp}.{uri}

The signature is calculated as:

  1. Get the current Unix timestamp in milliseconds
  2. Determine the payload:
    • For POST/PUT/PATCH/DELETE: Use {timestamp}.{body} where body is the request body
    • For GET: Use {timestamp}.{uri} where uri is the full request URI (e.g., /v2/members?limit=10)
  3. Calculate HMAC-SHA256 of the combined payload using your API secret
  4. Hex-encode the output
  5. Include the timestamp in the X-Timestamp header

Example for GET request to /v2/members?limit=10:

timestamp = 1699564800000
payload = "1699564800000./v2/members?limit=10"
signature = HMAC-SHA256(secret, payload)
X-Signature: hex(signature)
X-Timestamp: 1699564800000

Example for POST request with body {"topicId":"123","text":"Hello"}:

timestamp = 1699564800000
payload = '1699564800000.{"topicId":"123","text":"Hello"}'
signature = HMAC-SHA256(secret, payload)
X-Signature: hex(signature)
X-Timestamp: 1699564800000

For multipart/form-data requests, sign the exact raw request body bytes (including boundaries and file bytes) as transmitted.

X-Timestampinteger
Example:1699564800000

Unix timestamp in milliseconds when the request was created. Used for replay protection — requests older than 5 minutes are rejected.

Required only when authenticating with a static API key. Omit when using an OAuth access token.

Response

Org unit retrieved successfully

idstring uuid

The org unit ID

namestring

The org unit name

tagstring

The org unit tag (unique within the organization, used for @mentions)

type'Team' | 'Location'

The org unit type

memberIdsstring[]

Member profile IDs in the org unit (bot members use the b@<uuid> form)

createdAtinteger

Unix timestamp in milliseconds when the org unit was created

updatedAtinteger

Unix timestamp in milliseconds when the org unit was last updated

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Engineering",
  "tag": "eng",
  "type": "Team",
  "memberIds": [
    "550e8400-e29b-41d4-a716-446655440001",
    "b@660e8400-e29b-41d4-a716-446655440003"
  ],
  "createdAt": 1699564800000,
  "updatedAt": 1699564800000
}

Changes

No recorded changes to this operation across all 1 revision of this API.