Skip to content

Get organization by name

Request

Retrieve an organization by name. This should be called from the backend, using an admin access token (generated by a management app).

Required permissions: organizations:read, orgs:read.

Security
AdminAccessToken
Path
organization_namestringrequired

Name of the organization to retrieve

curl -i -X GET \
  'https://api.sbx.transmitsecurity.io/cis/v1/organizations/name/{organization_name}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
resultobjectrequired
Response
{
  "result": {
    "organization_id": "string",
    "app_ids": [ … ],
    "name": "string",
    "domain": "string",
    "domains": [ … ],
    "created_at": 0,
    "updated_at": 0,
    "enabled": true,
    "managed_organizations_by_app": { … },
    "managing_organization_id": "string",
    "logo_url": "string",
    "alias_name": "string"
  }
}