Skip to content
/
Get tenant information by...

Get tenant information by ID

Request

Context-aware tenant information retrieval:

UNAUTHENTICATED ACCESS:

  • No headers required
  • Returns: Basic public tenant information
Security
projectKey
Path
idstringrequired
curl -i -X GET \
  'https://docs.pers.ninja/_mock/swagger/tenants/{id}' \
  -H 'x-project-key: YOUR_API_KEY_HERE'

Responses

Tenant information retrieved successfully (data level depends on authentication)

Bodyapplication/json
projectNamestringrequired

Name of the tenant.

acronymstringrequired

Acronym of the tenant.

idstringrequired

Unique identifier for tenant. This id is used to identify tenant in the system for client requests.

createdAtstring, (date-time)required

Date when tenant was created.

projectDescriptionstring

Description of the tenant.

projectWebsitestring

Website of the tenant.

projectEmailstring

Email of the tenant.

projectImageUrlstring

Image URL of the tenant.

projectLogoUrlstring

Logo URL of the tenant.

projectApiKeystringrequired

Unique identifier for tenant. This id is used to identify tenant in the system for client requests.

Response
{
  "projectName": "string",
  "acronym": "string",
  "id": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "projectDescription": "string",
  "projectWebsite": "string",
  "projectEmail": "string",
  "projectImageUrl": "string",
  "projectLogoUrl": "string",
  "projectApiKey": "string"
}