---
updatedAt: 2026-04-30T17:53:32.000Z
---
Fetch the complete documentation index at: https://developers.pismo.io/pismo-docs/llms.txt. Use this file to discover all available pages before exploring further.
# Get organization
Returns information about a specific organization.
# OpenAPI definition
```json
{
"openapi": "3.1.0",
"info": {
"title": "Platform setup - Organizations",
"description": "View and manage organizations.
Note: An updated version of the Holidays API is available.",
"version": "v1.0",
"contact": {
"name": "Pismo Support",
"url": "https://developers.pismo.io/support/"
},
"license": {
"name": "Copyright Pismo"
}
},
"servers": [
{
"url": "https://sandbox.pismolabs.io",
"description": "Sandbox API server for testing."
}
],
"tags": [
{
"name": "Orgs",
"description": "View and manage some general origanization configurations"
}
],
"components": {
"parameters": {
"OrgIdPath2": {
"description": "Org ID",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string",
"example": "TN-cc8f8b89-233a-4582-9f36-63ee85278d6d"
}
},
"TenantIdHeader": {
"name": "x-tenant",
"in": "header",
"description": "Pismo organization ID",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "TN-cc8f8b89-233a-4582-9f36-63ee85278d6d"
}
}
},
"schemas": {
"AddressNumber": {
"type": "integer",
"format": "int32",
"description": "Your company's address number",
"example": 900
},
"City": {
"type": "string",
"description": "City name",
"maxLength": 60,
"example": "New York"
},
"ComplementaryAddress": {
"type": "string",
"description": "Any additional address information (unit, floor, and so on)",
"maxLength": 50,
"example": "Suite 123"
},
"Country": {
"type": "string",
"description": "Country name",
"maxLength": 30,
"example": "United States of America"
},
"CountryCode": {
"type": "string",
"description": "ISO-3166 three-letter country code.",
"maxLength": 3,
"example": "USA"
},
"CurrencyNumericCode": {
"type": "string",
"description": "ISO 4217 3-digit currency numeric code.",
"maxLength": 3,
"example": "986"
},
"CycleClosing": {
"type": "string",
"description": "Cycle closing time. Format = HH:MM:SS",
"example": "12:00:00"
},
"DocumentNumber": {
"type": "string",
"description": "Numeric ID that identifies your company (such as a government tax ID number)",
"maxLength": 20,
"example": "08350504000143"
},
"ExpirationDate": {
"type": "string",
"description": "Organization end date, provided for client tracking. RFC 3339 format. \n",
"example": "2019-07-03T17:23:18Z"
},
"HolidayCalendarId": {
"type": "number",
"description": "Holiday calendar ID.",
"example": 8675309
},
"HTTPError": {
"description": "Error",
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Error code"
},
"message": {
"type": "string"
}
}
},
"Language": {
"type": "string",
"description": "Language. Default is `en-US`",
"enum": [
"en-US",
"pt-BR"
],
"default": "en-US",
"example": "en-US"
},
"LegalProxyDocument": {
"type": "string",
"description": "ID (such as a government tax ID number) of your organization's legal representative",
"maxLength": 20,
"example": "123456"
},
"LegalProxyName": {
"type": "string",
"description": "Name of your organization's legal representative (person or other entity)",
"maxLength": 50,
"example": "Acme Corporation LTDA"
},
"Neighborhood": {
"type": "string",
"description": "Neighborhood. Some countries use neighborhood in their addresses.",
"maxLength": 50,
"example": "Bunker Hill"
},
"OfficialName": {
"type": "string",
"description": "Your company's legal name",
"minLength": 1,
"maxLength": 100,
"example": "Acme Corporation"
},
"OrgDetails": {
"description": "Organization details",
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/OrgID"
},
"official_name": {
"$ref": "#/components/schemas/OfficialName"
},
"org_name": {
"$ref": "#/components/schemas/OrgName"
},
"start_date": {
"$ref": "#/components/schemas/StartDate"
},
"expiration_date": {
"$ref": "#/components/schemas/ExpirationDate"
},
"document_number": {
"$ref": "#/components/schemas/DocumentNumber"
},
"address": {
"$ref": "#/components/schemas/StreetAddress"
},
"number": {
"$ref": "#/components/schemas/AddressNumber"
},
"complementary_address": {
"$ref": "#/components/schemas/ComplementaryAddress"
},
"neighborhood": {
"$ref": "#/components/schemas/Neighborhood"
},
"zipcode": {
"$ref": "#/components/schemas/PostalCode"
},
"city": {
"$ref": "#/components/schemas/City"
},
"state": {
"$ref": "#/components/schemas/State"
},
"country": {
"$ref": "#/components/schemas/Country"
},
"legal_proxy_name": {
"$ref": "#/components/schemas/LegalProxyName"
},
"legal_proxy_document": {
"$ref": "#/components/schemas/LegalProxyDocument"
},
"responsible": {
"$ref": "#/components/schemas/Responsible"
},
"currency_numeric_code": {
"$ref": "#/components/schemas/CurrencyNumericCode"
},
"timezone": {
"$ref": "#/components/schemas/Timezone"
},
"language": {
"$ref": "#/components/schemas/Language"
},
"country_code": {
"$ref": "#/components/schemas/CountryCode"
},
"cycle_closing": {
"$ref": "#/components/schemas/CycleClosing"
},
"holiday_calendar_id": {
"$ref": "#/components/schemas/HolidayCalendarId"
}
}
},
"OrgID": {
"type": "string",
"description": "Pismo organization ID",
"example": "TN-cc8f8b89-233a-4582-9f36-63ee85278d6d"
},
"OrgName": {
"type": "string",
"description": "Organization display name on the Pismo platform",
"minLength": 1,
"maxLength": 80,
"example": "Acme Corporation"
},
"PostalCode": {
"type": "string",
"description": "ZIP/postal code",
"maxLength": 9,
"example": "11203"
},
"Responsible": {
"type": "string",
"description": "Email of person at organization who can be contacted if necessary.",
"maxLength": 255
},
"StartDate": {
"type": "string",
"description": "Organization start date, provided for client tracking. RFC 3339 format. \n",
"example": "2019-07-03T17:23:18Z"
},
"State": {
"type": "string",
"description": "State/province/region. ISO 3166-2 (2 char) format.",
"maxLength": 2,
"example": "NY"
},
"StreetAddress": {
"type": "string",
"description": "Your company's street name",
"maxLength": 80,
"example": "Main Street"
},
"Timezone": {
"type": "string",
"description": "Timezone in TZ country/city or region format",
"maxLength": 60,
"example": "America/New_York"
}
},
"responses": {
"401UnauthorizedError": {
"description": "Unauthorized"
},
"404NotFound": {
"description": "Not Found"
}
},
"examples": {
"BadRequestResponse": {
"value": {
"code": "EOA0030",
"message": "Missing x-tenant header"
}
},
"InternalServerErrorResponse": {
"value": {
"code": "EOA0001",
"message": "Something went wrong, please try again later"
}
},
"OrgDetails": {
"value": {
"id": "TN-00000000000001",
"official_name": "Acme Corp",
"org_name": "Acme",
"document_number": "123456789",
"address": "Main Street",
"number": 25,
"complementary_address": "Suite 9",
"neighborhood": "Brooklyn",
"zipcode": "12345",
"city": "New York",
"state": "NY",
"country": "United Stated of America",
"legal_proxy_name": "Acme corporation LLC",
"legal_proxy_document": "95123123123",
"currency_numeric_code": "986",
"timezone": "America/New York",
"language": "en-US",
"country_code": "USA"
}
},
"TenantNotFoundResponse": {
"value": {
"code": "EOA0100",
"message": "Org TN-00000000000001 was not found"
}
},
"XTenantDiffResponse": {
"value": {
"code": "EOA0035",
"message": "X-Tenant header and request are different"
}
}
},
"securitySchemes": {
"S2SAuthentication": {
"type": "http",
"scheme": "bearer",
"description": "All requests must be previously authenticated with an account-specific token.",
"bearerFormat": "JWT"
}
}
},
"security": [
{
"S2SAuthentication": []
}
],
"paths": {
"/orgs-core/v1/orgs/{id}": {
"get": {
"summary": "Get organization",
"description": "Returns information about a specific organization.",
"operationId": "get-v1-org",
"tags": [
"Orgs"
],
"parameters": [
{
"$ref": "#/components/parameters/OrgIdPath2"
},
{
"$ref": "#/components/parameters/TenantIdHeader"
}
],
"responses": {
"200": {
"description": "Org data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrgDetails"
},
"examples": {
"response-v1-orgs": {
"$ref": "#/components/examples/OrgDetails"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPError"
},
"examples": {
"missing-x-tenant-header": {
"$ref": "#/components/examples/BadRequestResponse"
},
"different-x-tenant-header": {
"$ref": "#/components/examples/XTenantDiffResponse"
},
"tenant-not-found": {
"$ref": "#/components/examples/TenantNotFoundResponse"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/401UnauthorizedError"
},
"404": {
"$ref": "#/components/responses/404NotFound"
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPError"
},
"examples": {
"generic-internal-error": {
"$ref": "#/components/examples/InternalServerErrorResponse"
}
}
}
}
}
}
}
}
}
}
```